Catglobe Wiki - User contributions [en]

SendMailTemplateFromResource

2018-05-29T08:41:09Z

Nguyenhientrung:

{{HelpFiles}}

==== sendMailTemplateFromResource ====

send mail by an existing mail template

'''Syntax'''

sendMailTemplateFromResource(number parentResourceId, string email, string alias, number mailTemplateId [, fromEmail ] [, callback function(subject, message)]);

'''Arguments'''

''parentResourceId'': Is an expression of the type number. It is Resource Id of resource that contain these mail in communication tab after sending.

''email'': Is an expression of the type string. It is email address of receiver.

''alias'': Is an expression of the type string. Alias of receiver

''mailTemplateId'': Is an expression of the type number. It is Id of the mail template

''fromEmail'': Is an expression of the type string or EmailAccount. It is from email address.

''callback function(subject, message)'': Use to update mail when sending.

'''Return type'''

Empty

'''Examples'''
<source lang="javascript">
sendMailTemplateFromResource(15546533,"an@maysunshine.vn","An",1378);
</source>
<br /><source lang="javascript">
string firstName = "An";
string today = "2016-25-11";
sendMailTemplateFromResource(15546533,"an@maysunshine.vn","An",1378,"antest@cghead.catglobe.com",function(string subject, string message ){
subject = stringReplace(subject,"[Date]",today);
message = stringReplace(message,"[firstName]",firstName);
return {subject,message};
});

</source>
'''Availability''' Version 6.0
[[Category:Email_and_SMS_Functions]]

DataCacheSpecification class

2018-01-23T04:24:23Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=<nowiki>DataCacheSpecification</nowiki>
|Description=<nowiki>Represents a DataCache specification.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Instanciate an existing instance using the current context datacache</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>ResourceId</nowiki>|Description=<nowiki>Resource Id of the DataCache</nowiki>}}
|Description=<nowiki>Instanciate an existing instance using the resource id of a datacache</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>ResourceName</nowiki>|Description=<nowiki>Resource name of the new DataCache</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>Questionnaire Ids</nowiki>|Description=<nowiki>List of Questionnaires to use in the creation. Must all belong to same template</nowiki>}}
|Description=<nowiki>Create a new datacache using quick setup</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddFilter</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filterQuestionLabel</nowiki>|Description=<nowiki>Question to apply filter to. If empty, then clear current filters</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>filterValue</nowiki>|Description=<nowiki>Value of the filter</nowiki>}}
|Description=<nowiki>Add a filter to the DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddQuestionnaire</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Questionnaire to add</nowiki>}}
|Description=<nowiki>Add another questionnaire to the datacache. Return false if already added</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CreateAllColumnsForAllQuestions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>}}
|Description=<nowiki>Find and create all column for all questions. They still need to be saved individually to be added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CreateAllColumnsForQuestion</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>question</nowiki>|Description=<nowiki>QuestionLabel for the question you want all the dcs columns for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>}}
|Description=<nowiki>Find and create all column for a given question. They still need to be saved individually to be added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>CreateAllColumnsForQuestions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>questions</nowiki>|Description=<nowiki>QuestionLabels for the questions you want all the dcs columns for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>}}
|Description=<nowiki>Find and create all column for a given question. They still need to be saved individually to be added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>whereExpression</nowiki>|Description=<nowiki>The expression to execute. It must contain 'where' and NOT start with a equal sign, and have 1 and only one semicolon in it</nowiki>}}
|Description=<nowiki>Evaluate a single where expression up against the current DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>weight</nowiki>|Description=<nowiki>Column name of the weight to use in filter</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>weight</nowiki>|Description=<nowiki>Column name of the weight to use in filter</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>filters</nowiki>|Description=<nowiki>Extra filters that apply to all where expressions</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhere</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>weight</nowiki>|Description=<nowiki>Column name of the weight to use in filter</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>filters</nowiki>|Description=<nowiki>Extra filters that apply to all where expressions</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>freeTextFilters</nowiki>|Description=<nowiki>Extra free text search filters that apply to all where expressions</nowiki>}}
|Description=<nowiki>Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetSecondaryQuestionnaireJoinType</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>secondaryQuestionnaireResourceId</nowiki>|Description=<nowiki>Which secondary questionnaire</nowiki>}}
|Description=<nowiki>Get the way secondary questionnaires are joined with the primary, default is empty,empty (userId to userId)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>MakeContext</nowiki>|Description=<nowiki>Make the current DataCache the context DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Rebuild</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forceRebuild</nowiki>|Description=<nowiki>Rebuild even if dcs was already built and unchanged</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>waitForCompletion</nowiki>|Description=<nowiki>Do not return until the rebuild is complete</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>minAgeInMinutes</nowiki>|Description=<nowiki>Rebuild only if last build ended more than this amount of minutes ago, 0 to disable check. This supersedes forceRebuild</nowiki>}}
|Description=<nowiki>Rebuild the dcs. Notice this will commit the current transaction</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Reset</nowiki>|Description=<nowiki>Reset to initial quick setup</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetSecondaryQuestionnaireJoinType</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>secondaryQuestionnaireResourceId</nowiki>|Description=<nowiki>Which secondary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>primaryQuestionnaireMapping</nowiki>|Description=<nowiki>Which question to map to. Empty maps to userId. Empty string maps to QasId</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>secondaryQuestionnaireMapping</nowiki>|Description=<nowiki>Which question to map to. Empty maps to userId. Empty string maps to QasId</nowiki>}}
|Description=<nowiki>Change the way secondary questionnaires are joined with the primary, default is empty,empty (userId to userId)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetAllSecondaryQuestionnaireJoinType|Description=Get all the secondary questionnaires that are joined with the primary}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=ClearSecondaryQuestionnaireJoinType|Description=Delete all the secondary questionnaires which are joined with the primary}}
{{CGscriptMethods_Template|ReturnType=bool|Name=DeleteSecondaryQuestionnaireJoinType|Description=Delete the secondary questionnaire which is joined with the primary|Parameters=
{{CGscriptParameters_Template|Type=int|Name=secondaryQuestionnaireResourceId|Description=Which secondary questionnaire}}}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AutoUpdate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Auto Update</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>BuildWithWeight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the DataCache should be built using weights</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CachedRecords</nowiki>|HasGetter=1|Description=<nowiki>How many records does the DataCache currently hold</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>ColumnNames</nowiki>|HasGetter=1|Description=<nowiki>List of Column names</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Columns</nowiki>|HasGetter=1|Description=<nowiki>List of Column objects</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Completed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Deleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include deleted</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set description of the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Disabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include disabled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InterviewFailed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include marked as interview failed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InterviewSucceeded</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include marked as interview succeeded</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsOutOfDate</nowiki>|HasGetter=1|Description=<nowiki>Does the DataCache need to be rebuilt to have the correct content</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Language</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the iso code used in building the items that depend on a specific language</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastUpdated</nowiki>|HasGetter=1|Description=<nowiki>Time of the last rebuild</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Name of the DataCache resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Normal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include normal</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>NotStarted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those not yet started</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>OutsideTarget</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those marked outside target</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Partly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include partly completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=ProfilingResult|Name=<nowiki>ProfileFromLastEval</nowiki>|HasGetter=1|Description=<nowiki>Get the profile result from the last run of EvalWhere.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>QuestionnaireIds</nowiki>|HasGetter=1|Description=<nowiki>List of the questionnaires used in the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireTemplateId</nowiki>|HasGetter=1|Description=<nowiki>The resource id of the questionnaire template used in the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>QuotaFull</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those with full quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the DataCache</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Test</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set include those marked as test</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>UpdateFrequence</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Update Frequence in minutes</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of objects|Name=<nowiki>Weights</nowiki>|HasGetter=1|Description=<nowiki>Get list of existing weights.</nowiki>}}
}}

=== '''Examples''' ===

'''Ex1:'''

<source lang="javascript">
DCS_use(37244952); // set DCS context
string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
print(DCS_evaluateWhereExpression(e1)); // 68
DataCacheSpecification dcs = new DataCacheSpecification(); // Represent a DCS which is used as current DCS context
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}</source>

<br />
'''Ex2:'''

<source lang="javascript">
string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
DataCacheSpecification dcs = new DataCacheSpecification(37244952); // Represents a DCS which has Resource Id: 37244952
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}
dcs.MakeContext(); // or you can use DCS_use(RID) instead
print(DCS_evaluateWhereExpression(e1)); // without the previous statement (dcs.MakeContext();), you will get error at this line because there is no DCS context is set, so you can not use DCS_evaluateWhereExpression(e1)
dcs.Partly = false; // Not include the partly completed QASs
dcs.NotStarted = false; // Not include the not started QASs
dcs.Save(); // Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
</source>

<br />
'''Ex 3:'''

<source lang="javascript">
ProfilingResult pr;
DataCacheSpecification dcs = new DataCacheSpecification(12006923);
pr = dcs.ProfileFromLastEval;
pr.EnableProfiling = true;
dcs.EvalWhere({
"ex1": "count() where true"
});

print(pr.CompileTime); // 0.1694
print(pr.CountResult); // {"5": {"2": 1}, "9": {"4": 1}}
print(pr.DependencyGraphTime); // 0
print(pr.TimeResult); // {"10": {"-1": 0.0158, "4": 0.0158}, "11": {"-1": 0.0021, "4": 0.0021}, "5": {"-1": 1.1024, "2": 1.1024}, "9": {"-1": 0.0063, "4": 0.0063}}
print(pr.WhereExpTime); // 0
</source>

<br />
'''Ex 4:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array questionColumns = dcs.CreateAllColumnsForQuestion("Q1",0); //Create new column(s) for a question and use primary questionnaire

for(number i= 0; i < questionColumns.Count; i++){
questionColumns[i].Save(); //or method .Delete() in case removing column from dcs
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);

</source>

<br />
'''Ex 5:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array questionColumns = dcs.CreateAllColumnsForAllQuestions(15517148); //Create ALL columns for ALL questions.Set to 0 to use primary questionnaire

for(number i= 0; i < questionColumns.Count; i++){
questionColumns[i].Save();
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);
</source>

<br />
'''Ex 6:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15558382);
dcs.AddQuestionnaire(15558383);
dcs.Save();
</source>
'''Ex 7:''' Using freeTextFilters on EvalWhere

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15557696);
Dictionary d ={
"exp": "selectColumn(Id) where true;"
};
string freeTextFilters = "UserId: [39149 TO 47878]";
dcs.EvalWhere(d,"","",freeTextFilters);
</source>
'''Ex 8:''' CreateAllColumnsForQuestions
<source lang="javascript">
//*****Example for using CreateAllColumnsForQuestions*****//
//Constructor a DCS
number DCSRId = 15572568;
DataCacheSpecification dcs = new DataCacheSpecification(DCSRId);
//Add columns into the DCS
number qnaireRId = 15572331;// any qnaire that you want to add columns to the above DCS
array questionsLabel = {"District", "Age"};
Dictionary d = dcs.CreateAllColumnsForQuestions(questionsLabel, qnaireRId);//{"Age": {QcsQuestionColumn}, "District": {QcsQuestionColumn}}
array arrayQcsColumn = d.Values;//{{QcsQuestionColumn},{QcsQuestionColumn}}

for(number i=0;i<arrayQcsColumn.Count; i++)
{
array QcsColumn = arrayQcsColumn[i];//{QcsQuestionColumn}
for(number j=0; j<QcsColumn.Count; j++)
{
QcsQuestionColumn col = QcsColumn[j];
col.Save();
}
}
//Save DCS
dcs.Save();
</source>
'''Ex 9:''' Set/GetSecondaryQuestionnaireJoinType
<source lang="javascript">
//*****Example for using Set/GetSecondaryQuestionnaireJoinType*****//

//case name(question type text), name (question type number)
DCS_use(15567484);
DataCacheSpecification dcs = new DataCacheSpecification();
string primaryQnaireMapping = "CompanyNo_Text";
string secondaryQnaireMapping = "CompanyNo";
dcs.SetSecondaryQuestionnaireJoinType(15567469,primaryQnaireMapping,secondaryQnaireMapping);
dcs.Save();
dcs.GetSecondaryQuestionnaireJoinType(15567469);//{CompanyNo_Text,CompanyNo}
DCS_rebuild();

//case null, name: user id in primary is same as question in secondary
DCS_use(15567484);
DataCacheSpecification dcs = new DataCacheSpecification();
string primaryQnaireMapping = empty;
string secondaryQnaireMapping = "userId_A";
dcs.SetSecondaryQuestionnaireJoinType(15567469,primaryQnaireMapping,secondaryQnaireMapping);
dcs.Save();
DCS_rebuild();
dcs.GetSecondaryQuestionnaireJoinType(15567469);//{Empty,userId_A}
</source>
[[Category:Classes]]

Question getAll

2017-03-31T02:54:34Z

Nguyenhientrung:

[[Category:Questionnaire_Functions]]
{{HelpFiles}}

=== Question_getAll ===

Get all question by Questionnaire resource Id.

=== Syntax ===

Question_getAll(questionnaireResourceId[, Isocode]);

=== Arguments ===

questionnaireResourceId: is a number expression, it is resource id of Questionnaire.

Isocode: is a string expression, it is [http://www.lingoes.net/en/translator/langcode.htm Iso code] of language
=== Return type ===

array

=== Examples ===

<source lang="javascript">
Question_getAll(234110);
/*
{{12,6801,9,D_Initialize,,{},{}},{12,6805,5,D_InitializeJSON,,{},{}},{12,6802,4,BROWSER,,{},
{}},{12,6803,1,D_CurrentLanguage,,{{13,1,United Kingdom},{13,2,Gemany}},{}},{12,6804,1,Intro,,
{{13,1,I am from SUB},{13,2,I am from HQ}},{}},{12,6806,1,Q1,<p> Please rate the day on relevance and quality </p>,
{{13,1,Very low},{13,2,Low}, {13,3,Moderate},{13,4,High},{13,5,Very High}},{}}}
*/
</source> __NOTOC__

QuestionnaireStatistics class

2016-10-31T07:59:10Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=QuestionnaireStatistics
|Description=The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=qids|Description=An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.}}
|Description=Constructor to take many questionnaires}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=AverageInterviewSucceededTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of AverageInterviewSucceededTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of EstimatedTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTotalTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of EstimatedTotalTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRules|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NonSampleRules}}
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRulesWithData|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NonSampleRulesWithData}}
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRulesWithoutData|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NonSampleRulesWithoutData}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfActiveNotContactedRpq|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfActiveNotContactedRpq}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfActiveSample|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfActiveSample}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfAvailable|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfAvailable}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfAvailableActive|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfAvailableActive}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompleted|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfCompleted}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompletedToday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfCompletedToday}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompletedYesterday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfCompletedYesterday}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceeded|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfInterviewSucceeded}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceededToday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfInterviewSucceededToday}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceededYesterday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfInterviewSucceededYesterday}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfNotContactedRpq|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfNotContactedRpq}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfPartly|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfPartly}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfSample|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfSample}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfTestLink|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of NumberOfTestLink}}
{{CGscriptMethods_Template|ReturnType=number|Name=TargetReachedCount|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get count of TargetReachedCount}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=FirstInterview|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get start date of the first interview}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=LatestInterview|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get end date of the latest interview}}
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfEmails|Parameters=
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=Get number of emails was send out}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

QuestionnaireLayout class

2016-10-27T06:46:41Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=QuestionnaireLayout
|Description=A layout for a questionnaire
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=resourceId|Description=ResourceId of existing QuestionnaireLayout}}
|Description=Fetch existing QuestionnaireLayout}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Create new QuestionnaireLayout}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=The Id of the Resource}}
{{CGscriptProperties_Template|ReturnType=string|Name=ResourceName|HasGetter=1|Description=The name of the Resource}}
{{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Description of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=Html|HasGetter=1|HasSetter=1|Description=The Html of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=Css|HasGetter=1|HasSetter=1|Description=The Css of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the QuestionnaireLayout}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object}}
}}

=== <span style="color:#DF8621">'''Examples'''</span><br/> ===

<source lang="javascript">
number parentId = 1234;
QuestionnaireLayout l = new QuestionnaireLayout("Test layout", parentID);
l.Html = "<div id='questioncontent'>[[QUESTION]]</div><div id='navigationbar'>[[NAVIGATION]]</div>";
l.Css = ".cg-ui-question > .cg-ui-text {font-weight: bold;}";
l.Save();
l.ResourceId;
</source>

QuestionnaireLayout class

2016-10-27T06:41:02Z

Nguyenhientrung: Created page with "{{CGscriptClass_Template |Name=QuestionnaireLayout |Description=A layout for a questionnaire |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Te..."

{{CGscriptClass_Template
|Name=QuestionnaireLayout
|Description=A layout for a questionnaire
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=resourceId|Description=ResourceId of existing QuestionnaireLayout}}
|Description=Fetch existing QuestionnaireLayout}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name}}
{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Create new QuestionnaireLayout}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=The Id of the Resource}}
{{CGscriptProperties_Template|ReturnType=string|Name=ResourceName|HasGetter=1|Description=The name of the Resource}}
{{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Description of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=Html|HasGetter=1|HasSetter=1|Description=The Html of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=Css|HasGetter=1|HasSetter=1|Description=The Css of the QuestionnaireLayout}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the QuestionnaireLayout}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object}}
}}

=== <span style="color:#DF8621">'''Examples'''</span><br/> ===

<source lang="javascript">
number parentId = 1234;
QuestionnaireLayout l = new QuestionnaireLayout("Test layout", parentID);
l.Html = "<meta content='width=device-width'name=viewport><div id=body-in><div id=wrapper><div id=header><div id=logo></div></div><div id=questioncontent>[[QUESTION]]<div>[[COUNTDOWN]]</div><div>[[SPINNER]]</div></div><div id=footer><div id=navigationbar>[[NAVIGATION]]</div><div id=progressbar>[[PROGRESS]]</div></div></div></div>";
l.Css = ".cg-ui-question > .cg-ui-text {font-weight: bold;}";
l.Save();
l.ResourceId;
</source>

PanelStatistics class

2016-03-16T10:43:31Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=panelCreationQuestionnaireResourceId|Description=If >0 then the endodate of qas in this questionnaire is used for creation date, otherwise the user created date is used}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32, 2014}. Grouping by year is returned as {2014, 2014}.}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalAvailablePoints|Description=Sum of points panel members has available at the 'to' date}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalEarnedPoints|Description=Sum of points panel members earned}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalUsedPoints|Description=Sum of points panel members used}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountEarnedPoints|Description=Number of points panel members earned}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=TotalEarnedPointsBySurvey|Description=Dictionary of questionnaire id and number of points panel members earned for that questionnaire}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPoints|Description=Number of points panel members used. Included points spent on shopping and subtracted for going back in a questionnaire.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPointsOnOrders|Description=Number of points panel members used for shopping.}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

array CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

PanelStatistics class

2016-03-16T10:40:44Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32, 2014}. Grouping by year is returned as {2014, 2014}.}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalAvailablePoints|Description=Sum of points panel members has available at the 'to' date}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalEarnedPoints|Description=Sum of points panel members earned}}
{{CGscriptMethods_Template|ReturnType=number|Name=TotalUsedPoints|Description=Sum of points panel members used}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountEarnedPoints|Description=Number of points panel members earned}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=TotalEarnedPointsBySurvey|Description=Dictionary of questionnaire id and number of points panel members earned for that questionnaire}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPoints|Description=Number of points panel members used. Included points spent on shopping and subtracted for going back in a questionnaire.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPointsOnOrders|Description=Number of points panel members used for shopping.}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

array CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

User insertPoints

2016-03-16T08:41:29Z

Nguyenhientrung:

[[Category:User_Functions]]
{{HelpFiles}}

==== User_insertPoints ====

Add points to a user

'''Syntax'''

User_insertPoints(''points, description''): add points for a user in current RPQ context. '''Note''': use this function so we can analyze points data by questionnaire and have tracking information

User_insertPoints(''points, description, userResourceId''): add manual transaction point for a user

'''Arguments'''

*''points'': is a ''number ''expression. It is the number of points to add
*''description'': is a ''string ''expression. It is the description of the transaction
*''userResourceId'': is a ''number ''expression. It is the resource id of a user

'''Return value'''

empty

'''Example'''

''User_insertPoints(120, "some description", 46898);''

'''Availability'''

Version 5.6 __NOTOC__

User insertPoints

2016-03-16T08:40:20Z

Nguyenhientrung:

[[Category:User_Functions]]
{{HelpFiles}}

==== User_insertPoints ====

Add points to a user

'''Syntax'''

User_insertPoints(''points, description''): add points for a user in current RPQ context. '''Note''': use this function so we can analyze points data by questionnaire and have tracking infomation

User_insertPoints(''points, description, userResourceId''): add manual transaction point for a user

'''Arguments'''

*''points'': is a ''number ''expression. It is the number of points to add
*''description'': is a ''string ''expression. It is the description of the transaction
*''userResourceId'': is a ''number ''expression. It is the resource id of a user

'''Return value'''

empty

'''Example'''

''User_insertPoints(120, "some description", 46898);''

'''Availability'''

Version 5.6 __NOTOC__

Goto and clear if

2016-01-11T08:40:20Z

Nguyenhientrung:

[[Category:Conditions]]
==== Go to and clear if ====

Syntax : GOTO LABEL (IF EXPRESSION) ANDCLEAR [LABEL1(,LABEL2)]

<nowiki>*Argument:</nowiki>

LABEL : label of an other question

<nowiki>*If IF EXPRESSION is not defined, the expression of condition will have the value "true"</nowiki>

[LABEL1(,LABEL2)]: list of question will be delete data if condition is met

Position : At the end of question declaration

This condition support all question type

Example :

QUESTION testPage PAGE

This is question text

GOTO anotherQuestion_1 IF (QTest == 1) ANDCLEAR [Q1,Q2]

Goto and clear if

2016-01-11T08:40:04Z

Nguyenhientrung: Created page with "[{Category:Conditions]] ==== Go to and clear if ==== Syntax : GOTO LABEL (IF EXPRESSION) ANDCLEAR [LABEL1(,LABEL2)] <nowiki>*Argument:</nowiki> LABEL : label of a..."

[{Category:Conditions]]
==== Go to and clear if ====

Syntax : GOTO LABEL (IF EXPRESSION) ANDCLEAR [LABEL1(,LABEL2)]

<nowiki>*Argument:</nowiki>

LABEL : label of an other question

<nowiki>*If IF EXPRESSION is not defined, the expression of condition will have the value "true"</nowiki>

[LABEL1(,LABEL2)]: list of question will be delete data if condition is met

Position : At the end of question declaration

This condition support all question type

Example :

QUESTION testPage PAGE

This is question text

GOTO anotherQuestion_1 IF (QTest == 1) ANDCLEAR [Q1,Q2]

Show or clear if

2016-01-11T08:26:50Z

Nguyenhientrung: Created page with "Category:Conditions ==== Show or clear if ==== Syntax : IF EXPRESSION ORCLEARCURRENT Position : Right after question type and before question properties ( if ..."

[[Category:Conditions]]

==== Show or clear if ====

Syntax : IF EXPRESSION ORCLEARCURRENT

Position : Right after question type and before question properties ( if it existed )

A question can have many show if condition

Example 1 :

QUESTION qTest TEXT

IF (anotherQuestion == 1) ORCLEARCURRENT

This is question text

Example 2 :

QUESTION qTest TEXT

IF (anotherQuestion_1 == 1) ORCLEARCURRENT

IF (anotherQuestion_2 == 1) ORCLEARCURRENT

This is question text

Condition name: Goto question and clear if

2016-01-11T08:10:25Z

Nguyenhientrung:

[[Category:Question_conditions]]
[[Category:Question_conditions]]
== Condition name: Go to question and clear if ==

'''Question types applied'''

All

'''Description'''

When a respondent has answered a question with this condition related to it and clicks next, then the condition will be tested before going on to the next question in the questionnaire.

If the condition is met then the user will be sent to a specified question in the questionnaire (which is normally not the next question in the questionnaire), and '''all selected question in "Clear data" list of condition will be delete its data.'''

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead.

A question may have multiple "Go to question and clear if" conditions. The system will check one at a time, starting with the top one, and if any of the conditions are met then the system will ignore the remaining conditions and immediately fulfill the "go to" requirements of that condition.

'''Clear data list'''

*The list should default to all from (but not including) the current question to (and including) the target question
*The user may then add or remove questions
*If a question is inserted or moved in/out clear range or the current question / target question moved around, it will be update automatic clear range
*In the list of questions, a question that participates in a clear range should have indication that it is and mouseover should inform which questions might clear the data of this question if their GOTO is triggered

'''Example'''

'''[[File:GotoAndClearIf31.png|none|GotoAndClearIf31.png]]'''

'''[[File:GotoAndClearIf2.png|none|GotoAndClearIf2.png]]'''

'''Version''' 6.0

Condition name: Goto question and clear if

2016-01-11T08:07:37Z

Nguyenhientrung:

[[Category:Question_conditions]]
== Condition name: Go to question and clear if ==

'''Question types applied'''

All

'''Description'''

When a respondent has answered a question with this condition related to it and clicks next, then the condition will be tested before going on to the next question in the questionnaire.

If the condition is met then the user will be sent to a specified question in the questionnaire (which is normally not the next question in the questionnaire), and '''all selected question in "Clear data" list of condition will be deleted.'''

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead.

A question may have multiple "Go to question and clear if" conditions. The system will check one at a time, starting with the top one, and if any of the conditions are met then the system will ignore the remaining conditions and immediately fulfill the "go to" requirements of that condition.

'''Clear data list'''

*The list should default to all from (but not including) the current question to (and including) the target question
*The user may then add or remove questions
*If a question is inserted or moved in/out clear range or the current question / target question moved around, it will be update automatic clear range
*In the list of questions, a question that participates in a clear range should have indication that it is and mouseover should inform which questions might clear the data of this question if their GOTO is triggered

'''Example'''

'''[[File:GotoAndClearIf31.png|none|GotoAndClearIf31.png]]'''

'''[[File:GotoAndClearIf2.png|none|GotoAndClearIf2.png]]'''

'''Version''' 6.0

Condition name: Goto question and clear if

2016-01-11T08:07:20Z

Nguyenhientrung:

== Condition name: Go to question and clear if ==

'''Question types applied'''

All

'''Description'''

When a respondent has answered a question with this condition related to it and clicks next, then the condition will be tested before going on to the next question in the questionnaire.

If the condition is met then the user will be sent to a specified question in the questionnaire (which is normally not the next question in the questionnaire), and '''all selected question in "Clear data" list of condition will be deleted.'''

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead.

A question may have multiple "Go to question and clear if" conditions. The system will check one at a time, starting with the top one, and if any of the conditions are met then the system will ignore the remaining conditions and immediately fulfill the "go to" requirements of that condition.

'''Clear data list'''

*The list should default to all from (but not including) the current question to (and including) the target question
*The user may then add or remove questions
*If a question is inserted or moved in/out clear range or the current question / target question moved around, it will be update automatic clear range
*In the list of questions, a question that participates in a clear range should have indication that it is and mouseover should inform which questions might clear the data of this question if their GOTO is triggered

'''Example'''

'''[[File:GotoAndClearIf31.png|none|GotoAndClearIf31.png]]'''

'''[[File:GotoAndClearIf2.png|none|GotoAndClearIf2.png]]'''

'''Version''' 6.0

Condition name: Goto question and clear if

2016-01-11T08:01:11Z

Nguyenhientrung:

[[Category:Question_conditions]]
== Condition name: Go to question and clear if ==

'''Question types applied'''

All

'''Description'''

When a respondent has answered a question with this condition related to it and clicks next, then the condition will be tested before going on to the next question in the questionnaire.

If the condition is met then the user will be sent to a specified question in the questionnaire (which is normally not the next question in the questionnaire), and '''all selected question in "Clear data" list of condition will be deleted.'''

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead.

A question may have multiple "Go to question and clear if" conditions. The system will check one at a time, starting with the top one, and if any of the conditions are met then the system will ignore the remaining conditions and immediately fulfill the "go to" requirements of that condition.

'''Clear data list'''

*The list should default to all from (but not including) the current question to (and including) the target question
*The user may then add or remove questions
*If a question is inserted (ie, moved around) into an unbroken range, it should be included. (you probably need a special case for questions inserted just before or after the 'from' question)
*In the list of questions, a question that participates in a clear range should have some indication that it is and mouseover should inform which questions might clear the data of this question if their GOTO is triggered

'''Example'''

'''[[File:GotoAndClearIf31.png|none|GotoAndClearIf31.png]]'''

'''[[File:GotoAndClearIf2.png|none|GotoAndClearIf2.png]]'''

'''Version''' 6.0

File:GotoAndClearIf31.png

2016-01-11T07:59:49Z

Nguyenhientrung: MsUpload

MsUpload

Condition name: Goto question and clear if

2016-01-11T07:58:24Z

Nguyenhientrung: Created page with "Category:Question_conditions == Condition name: Go to question and clear if == '''Question types applied''' All '''Description''' When a respondent has answered a que..."

[[Category:Question_conditions]]

== Condition name: Go to question and clear if ==

'''Question types applied'''

All

'''Description'''

When a respondent has answered a question with this condition related to it and clicks next, then the condition will be tested before going on to the next question in the questionnaire.

If the condition is met then the user will be sent to a specified question in the questionnaire (which is normally not the next question in the questionnaire), and '''all selected question in "Clear data" list of condition will be deleted.'''

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead.

A question may have multiple "Go to question and clear if" conditions. The system will check one at a time, starting with the top one, and if any of the conditions are met then the system will ignore the remaining conditions and immediately fulfill the "go to" requirements of that condition.

'''Clear data list'''

*The list should default to all from (but not including) the current question to (and including) the target question
*The user may then add or remove questions
*If a question is inserted (ie, moved around) into an unbroken range, it should be included. (you probably need a special case for questions inserted just before or after the 'from' question)
*In the list of questions, a question that participates in a clear range should have some indication that it is and mouseover should inform which questions might clear the data of this question if their GOTO is triggered

'''Example'''

'''[[File:GotoAndClearIf1.png|none|GotoAndClearIf1.png]]'''

'''[[File:GotoAndClearIf2.png|none|GotoAndClearIf2.png]]'''

'''Version''' 6.0

File:GotoAndClearIf2.png

2016-01-11T07:55:30Z

Nguyenhientrung: MsUpload

MsUpload

File:GotoAndClearIf1.png

2016-01-11T07:55:29Z

Nguyenhientrung: MsUpload

MsUpload

Condition name: Show question or clear if

2016-01-11T07:37:13Z

Nguyenhientrung:

[[Category:Question_conditions]]
====== Condition name: Show question or clear if<br/> ======

'''Question types applied'''

All exclude page, multimedia

'''Description'''

When a respondent reaches this question and this condition exists, then the condition will be tested before the question is shown. If the condition is met then the user will be shown the question.

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead, '''if this question had answered (in case the respondent go back), its data will be delete'''

A question may have multiple "Show question or clear if" conditions. For the system to skip the question just one of these conditions need to fail.

'''Example'''

[[File:ShowOrClearIf1.png|none|ShowOrClearIf1.png]]

[[File:ShowOrClearIf2.png|none]]

'''Version''' 6.0

File:ShowOrClearIf2.png

2016-01-11T07:35:18Z

Nguyenhientrung: MsUpload

MsUpload

File:ShowOrClearIf1.png

2016-01-11T07:35:17Z

Nguyenhientrung: MsUpload

MsUpload

Condition name: Show question or clear if

2016-01-11T07:34:18Z

Nguyenhientrung:

====== Condition name: Show question or clear if<br/> ======

'''Question types applied'''

All exclude page, multimedia

'''Description'''

When a respondent reaches this question and this condition exists, then the condition will be tested before the question is shown. If the condition is met then the user will be shown the question.

If the condition fails then the user will skip the question and be sent to the next question in the questionnaire instead, '''if this question had answered (in case the respondent go back), its data will be delete'''

A question may have multiple "Show question or clear if" conditions. For the system to skip the question just one of these conditions need to fail.

'''Example'''

'''[[File:01.png|none|01.png]]'''

Condition name: Show question or clear if

2016-01-11T07:32:00Z

Nguyenhientrung:

Condition name: Show question or clear if

2016-01-11T07:25:00Z

Nguyenhientrung:

Condition name: Show question or clear if

2016-01-11T07:21:13Z

Nguyenhientrung: Created page with "====== Condition name: Show question or clear if<br/> ====== '''Question types applied''' All exclude page, multimedia '''Description''' When a respondent reaches this que..."

Resource searchByName

2015-12-09T03:22:37Z

Nguyenhientrung:

= Resource_searchByName =
[[Category:Resource_Functions]]
__NOTOC__

Search resources by name.

=== <span style="color:#DF8621">'''Syntax'''</span> ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, SearchType, SearchMaxCount)

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, SearchType, SearchMaxCount, ParentResourceId)

=== <span style="color:#DF8621">'''Arguments'''</span> ===

*ResourceName: is a string. It is the pattern of name of resource which user want to look up.
*ResourceType: is a value of Resource type constants. Or we can also use the name of [[CGS Constants list|Resource type constants]].
*ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.
*SearchType: is a number. It's the value of the Search type constants. Or we can aslo use the name of [[CGS Constants list|the Search type constants]].
*SearchMaxCount: is a number. It's the number of resources we want this function return. default vaulue = 10, if set value to 0, it'll return all
*ParentResourceId: is a number. It's resource id used to determine search resources in it

The SearchType constants list:

*NAME_SEARCH_TYPE_START
*NAME_SEARCH_TYPE_END
*NAME_SEARCH_TYPE_ANYWHERE
*NAME_SEARCH_TYPE_IDENTICAL

=== <span style="color:#DF8621;">'''Return type'''</span> ===

An array of matched resources, which contain the information of resources that match the search pattern. <br>

The matched resources will be represent by an array. Below is the constants list which explain the meaning of each element in this array:

*RESOURCE_RESOURCE_ID : Rid of resource
*RESOURCE_NAME : Name of resource
*RESOURCE_TYPE : Type of resource
*RESOURCE_PARENT_RESOURCE_ID : Rid of parent resource
*RESOURCE_TEMPLATE_RESOURCE_ID : Rid of resource template

=== <span style="color:#DF8621;">'''Examples'''</span> ===
<source lang="javascript">
string ResourceNamePattern = "phong";
number ResourceType = 10; // or ResourceType = Resource_Type_Report;
number ResourceTempRID = 0;
number SearchType = 1; // or SearchType = NAME_SEARCH_TYPE_ANYWHERE;

Number SearchMaxcount= 3;
array Result;

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType);
print(Result.Count);
print(Result);

// 5 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}}

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType, SearchMaxcount);
print(Result.Count);
print(Result);

// 3 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964}}

</source>

Resource searchByName

2015-12-09T03:17:08Z

Nguyenhientrung:

= Resource_searchByName =
[[Category:Resource_Functions]]
__NOTOC__

Search resources by name.

=== <span style="color:#DF8621">'''Syntax'''</span> ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, SearchType, SearchMaxCount)

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, SearchType, SearchMaxCount, ParentResourceId)

=== <span style="color:#DF8621">'''Arguments'''</span> ===

*ResourceName: is a string. It is the pattern of name of resource which user want to look up.
*ResourceType: is a value of Resource type constants. Or we can also use the name of [[CGS Constants list|Resource type constants]].
*ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.
*SearchType: is a number. It's the value of the Search type constants. Or we can aslo use the name of [[CGS Constants list|the Search type constants]].
*SearchMaxCount: is a number. It's the number of resources we want this function return. default vaulue = 10, if set value to 0, it'll return all

The SearchType constants list:

*NAME_SEARCH_TYPE_START
*NAME_SEARCH_TYPE_END
*NAME_SEARCH_TYPE_ANYWHERE
*NAME_SEARCH_TYPE_IDENTICAL

=== <span style="color:#DF8621;">'''Return type'''</span> ===

An array of matched resources, which contain the information of resources that match the search pattern. <br>

The matched resources will be represent by an array. Below is the constants list which explain the meaning of each element in this array:

*RESOURCE_RESOURCE_ID : Rid of resource
*RESOURCE_NAME : Name of resource
*RESOURCE_TYPE : Type of resource
*RESOURCE_PARENT_RESOURCE_ID : Rid of parent resource
*RESOURCE_TEMPLATE_RESOURCE_ID : Rid of resource template

=== <span style="color:#DF8621;">'''Examples'''</span> ===
<source lang="javascript">
string ResourceNamePattern = "phong";
number ResourceType = 10; // or ResourceType = Resource_Type_Report;
number ResourceTempRID = 0;
number SearchType = 1; // or SearchType = NAME_SEARCH_TYPE_ANYWHERE;

Number SearchMaxcount= 3;
array Result;

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType);
print(Result.Count);
print(Result);

// 5 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}}

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType, SearchMaxcount);
print(Result.Count);
print(Result);

// 3 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964}}

</source>

PanelStatistics class

2015-04-13T09:17:04Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32, 2014}. Grouping by year is returned as {2014, 2014}.}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

array CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

PanelStatistics class

2015-04-13T09:16:07Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32, 2014}. Grouping by year is returned as {2014, 2014}}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

array CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

PanelStatistics class

2015-04-13T09:14:00Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

number CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

PanelStatistics class

2015-04-13T09:03:33Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=PanelStatistics
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=The count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
|Description=Create new statistics}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
{{CGscriptMethods_Template|ReturnType=number|Name=CountTotal|Description=The number of panel members including disabled.}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== Examples ===

<source lang="javascript">

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

number CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
</source>

Replacement tags

2014-10-14T03:44:18Z

Nguyenhientrung:

=== Replacement tags ===

__NOTOC__
There exists a tag system which makes it possible for us, to insert replacement values directly in texts (question, subquestion, answer option) without using text replacement conditions. These tags are replaced by the answer the respondent gave in an earlier question of the same questionnaire.

An example could be:

''<nowiki>”You have answered that your favorite soft drink is {{FavoriteSoftdrink.Text}}.”</nowiki>''

Which could result in a text like:

''”You have answered that your favorite soft drink is Cherry Coke”''

The logic for text replacement tags are as follows:

Q_Label should in the following be replaced by the question that replacement texts are to be collected from. How the replacement tags are to be used depends on which question type the tag refers to. Examples of all are presented below:

==== '''Single''' ====

<nowiki>{{Q_label}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.value}}: is replaced with the value of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.text}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.openvalue}}: is replaced with the open text part of the respondent's chosen answer option (if such a value exists)</nowiki>

<nowiki>{{Q_label.index}}: is replaced with the index of the respondent's chosen answer option</nowiki>

==== '''Multi''' ====

<nowiki>{{Q_label[AnswerOption_index]}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].value}}: is replaced with the value of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].text}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].openvalue}}: is replaced with the open text part of the respondent's chosen answer option (if such a value exists)</nowiki>

<nowiki>{{Q_label[AnswerOption_index].index}}: is replaced with the index of the respondent's chosen answer option</nowiki>

==== '''Single Grid''' ====

<nowiki>{{Q_label[grid_index]}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].value}}: is replaced with the value of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].text}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].index}}: is replaced with the index of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>** grid_index should be replaced with the index of the subquestion the users wants the text replacement based on. The first subquestion is always indexed with 0, next one is 1 and so on.</nowiki>

==== Multi Grid<br/> ====

<nowiki>{{Q_label[grid_index][AnswerOption_index]}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].value}}: is replaced with the value of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].text}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].index}}: is replaced with the index of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>** grid_index should be replaced with the index of the subquestion the users wants the text replacement based on. The first subquestion is always indexed with 0, next one is 1 and so on.</nowiki>

==== '''Text, Open, Multimedia, Scale, Numeric'''<br/> ====

<nowiki>{{Q_label}}: is replaced with the respondent's actual answer</nowiki>

==== '''Open - closed answer'''<br/> ====

<nowiki>{{Q_label[option_index]}}: return true/false, get status checked of closed answer options</nowiki>

==== '''Scale Grid, Text Grid'''<br/> ====

<nowiki>{{Q_label[grid_index]}}: is replaced with the respondent's actual answer to the specified sub question</nowiki>

==== '''CGScript'''<br/> ====

<nowiki>{{Script;}}: CGScript can also be run in text by placing them in the {{}} brackets. </nowiki>

Replacement tags

2014-10-14T03:43:28Z

Nguyenhientrung:

=== Replacement tags ===

__NOTOC__
There exists a tag system which makes it possible for us, to insert replacement values directly in texts (question, subquestion, answer option) without using text replacement conditions. These tags are replaced by the answer the respondent gave in an earlier question of the same questionnaire.

An example could be:

''<nowiki>”You have answered that your favorite soft drink is {{FavoriteSoftdrink.Text}}.”</nowiki>''

Which could result in a text like:

''”You have answered that your favorite soft drink is Cherry Coke”''

The logic for text replacement tags are as follows:

Q_Label should in the following be replaced by the question that replacement texts are to be collected from. How the replacement tags are to be used depends on which question type the tag refers to. Examples of all are presented below:

==== '''Single''' ====

<nowiki>{{Q_label}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.value}}: is replaced with the value of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.text}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label.openvalue}}: is replaced with the open text part of the respondent's chosen answer option (if such a value exists)</nowiki>

<nowiki>{{Q_label.index}}: is replaced with the index of the respondent's chosen answer option</nowiki>

==== '''Multi''' ====

<nowiki>{{Q_label[AnswerOption_index]}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].value}}: is replaced with the value of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].text}}: is replaced with the text of the respondent's chosen answer option</nowiki>

<nowiki>{{Q_label[AnswerOption_index].openvalue}}: is replaced with the open text part of the respondent's chosen answer option (if such a value exists)</nowiki>

<nowiki>{{Q_label[AnswerOption_index].index}}: is replaced with the index of the respondent's chosen answer option</nowiki>

==== '''Single Grid''' ====

<nowiki>{{Q_label[grid_index]}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].value}}: is replaced with the value of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].text}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index].index}}: is replaced with the index of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>** grid_index should be replaced with the index of the subquestion the users wants the text replacement based on. The first subquestion is always indexed with 0, next one is 1 and so on.</nowiki>

==== Multi Grid<br/> ====

<nowiki>{{Q_label[grid_index][AnswerOption_index]}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].value}}: is replaced with the value of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].text}}: is replaced with the text of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>{{Q_label[grid_index][AnswerOption_index].index}}: is replaced with the index of the respondent's chosen answer option on the specified sub question</nowiki>

<nowiki>** grid_index should be replaced with the index of the subquestion the users wants the text replacement based on. The first subquestion is always indexed with 0, next one is 1 and so on.</nowiki>

==== '''Text, Open, Multimedia, Scale, Numeric'''<br/> ====

<nowiki>{{Q_label}}: is replaced with the respondent's actual answer</nowiki>

==== '''Open - closed answer'''<br/> ====

<nowiki>{{Q_label[index]}}: return true/false, get status checked of closed answer options</nowiki>

==== '''Scale Grid, Text Grid'''<br/> ====

<nowiki>{{Q_label[grid_index]}}: is replaced with the respondent's actual answer to the specified sub question</nowiki>

==== '''CGScript'''<br/> ====

<nowiki>{{Script;}}: CGScript can also be run in text by placing them in the {{}} brackets. </nowiki>

Resource searchByName

2014-09-24T07:09:11Z

Nguyenhientrung:

= Resource_searchByName =
[[Category:Resource_Functions]]
__NOTOC__

Search resources by name.

=== <span style="color:#DF8621;">'''Syntax'''</span> ===

Resource_searchByName(ResourceName, ResourceType, ResourceTemplateResourceID, SearchType, SearchMaxCount)
<br>

=== <span style="color:#DF8621">'''Arguments'''</span> ===

*ResourceName: is a string. It is the pattern of name of resource which user want to look up.
*ResourceType: is a value of Resource type constants. Or we can also use the name of [[CGS Constants list|Resource type constants]].
*ResourceTemplateResourceID: is a number. It is the resource id of resource template ID. This value can be set 0 if don't care which template to search for.
*SearchType: is a number. It's the value of the Search type constants. Or we can aslo use the name of [[CGS Constants list|the Search type constants]].
*SearchMaxCount: is a number. It's the number of resources we want this function return. default vaulue = 10, if set value to 0, it'll return all

The SearchType constants list:

*NAME_SEARCH_TYPE_START
*NAME_SEARCH_TYPE_END
*NAME_SEARCH_TYPE_ANYWHERE
*NAME_SEARCH_TYPE_IDENTICAL

=== <span style="color:#DF8621;">'''Return type'''</span> ===

An array of matched resources, which contain the information of resources that match the search pattern. <br>

The matched resources will be represent by an array. Below is the constants list which explain the meaning of each element in this array:

*RESOURCE_RESOURCE_ID : Rid of resource
*RESOURCE_NAME : Name of resource
*RESOURCE_TYPE : Type of resource
*RESOURCE_PARENT_RESOURCE_ID : Rid of parent resource
*RESOURCE_TEMPLATE_RESOURCE_ID : Rid of resource template

=== <span style="color:#DF8621;">'''Examples'''</span> ===
<source lang="javascript">
string ResourceNamePattern = "phong";
number ResourceType = 10; // or ResourceType = Resource_Type_Report;
number ResourceTempRID = 0;
number SearchType = 1; // or SearchType = NAME_SEARCH_TYPE_ANYWHERE;

Number SearchMaxcount= 3;
array Result;

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType);
print(Result.Count);
print(Result);

// 5 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964},{10,37272427,Phong report 4,12,37246022,34409964},{10,37272501,phong,12,37272491,34409964}}

Result = Resource_searchByName(ResourceNamePattern, ResourceType, ResourceTempRID, SearchType, SearchMaxcount);
print(Result.Count);
print(Result);

// 3 resources were found
//{{10,37257205,Phong report 2,12,37246022,34409964},{10,37257212,Phong report 1,12,37246022,34409964},{10,37272405,phong report 3,12,37246022,34409964}}

</source>

Attachment class

2014-09-18T03:11:13Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=Attachment
|Description= Represents an attachment object<br/>
NOTE : can't use with mail template, bulk mail
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=resourceId|Description=ResourceId of existing attachment}}
|Description=Fetch existing attachment}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file}}{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Create new attachment}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=GetChildAttachments|Parameters=
{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Get all of the attachments associated with the resource}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromDownload|Parameters=
{{CGscriptParameters_Template|Type=WebResponse|Name=response|Description=Response from HttpRequest}}
|Description=Download from an HttpRequest's response}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromFileCopy|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Name of the file}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}}
|Description=Copy from an already stored file using Catglobe.File}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=FileSize|HasGetter=1|Description=The size of the file on disc}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object}}
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=The Id of the Attachment}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

Attachment class

2014-09-18T03:09:49Z

Nguyenhientrung:

{{CGscriptClass_Template
|Name=Attachment
|Description= Represents an attachment object
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=resourceId|Description=ResourceId of existing attachment}}
|Description=Fetch existing attachment}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file}}{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Create new attachment}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=GetChildAttachments|Parameters=
{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource}}
|Description=Get all of the attachments associated with the resource}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromDownload|Parameters=
{{CGscriptParameters_Template|Type=WebResponse|Name=response|Description=Response from HttpRequest}}
|Description=Download from an HttpRequest's response}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromFileCopy|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Name of the file}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}}
|Description=Copy from an already stored file using Catglobe.File}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=FileSize|HasGetter=1|Description=The size of the file on disc}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object}}
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=The Id of the Attachment}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

NOTE : can't use with mail template, bulk mail

Attachment class

2014-09-18T03:08:27Z

Nguyenhientrung:

Attachment class

2014-09-18T03:05:26Z

Nguyenhientrung: Created page with "{{CGscriptClass_Template |Name=Attachment |Description= Represents an attachment object |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Templat..."