Catglobe Wiki - User contributions [en]

Questionnaire links

2026-10-14T09:03:56Z

Nguyenduyan:

__TOC__
== Questionnaire links ==

Links to questionnaires can be created in a number of ways to support various actions upon users viewing their answer sheets. One type of link is recurring links where clicking the link will automatically generate a new answer sheet for that user. The basic part of the link can be found on the information dialog on the questionnaire list. By default the tag '&n=1' will have been added.

[[Image:3096.png|400px|Recurring link]]

{| style="width: 965px; height: 164px;" cellspacing="1" cellpadding="1" border="1"
|-
| r=[qasGUID] 
| Open directly an existing answer sheet 
|-
| r=[qnaireGUID] 
| Use combine questionanire guid with below tags for open existing answer sheet or generate new answer sheet 
|-
| &n=1 
| Will generate a new answer sheet each time the link is clicked. But it will check whether the user has a cookie telling Catglobe that this user should return to the initial answer sheet he created using the link and thus try to avoid that any one user uses the link more than once. 
|-
| &n=2 
| Similar to n=1 except that it will actually also generate a new user to attach to the answer sheet created. There may be various reasons why you would want to create user accounts when users use the link. You may for example have CGScript in your questionnaire that send information to update the user object with demographic data. 
|-
| &n=3 
| Will generate a new answer sheet for logged in user each time the link clicked (need to be logged in before) 
|-
| &c=[accessCode] 
| Will open an existing answer sheet beloging to that access code 
|-
| &uac=1 
| Will open a page for typing accessCode and then will open existing answer sheet beloging to that access code. See more [[Code_protected_answer_sheets]] 
|-
| &b=1 
| When this tag is added we will ignore that the logged in user has a session cookie which informs us that he has already started on a different answer sheet. We will instead just generate a new answer sheet to answer each time the user clicks the link! 
|-
| &l=[language] 
| Where [language] should be replaced by the iso code of the language that the user should see the questionnaire in.E.g. 'l=da-DK'. 
|-
| &u=[username] 
| If you did not choose &n=1 or &n=2 then you can instead specify user's user name and passwords as tags to let the system find an existing answer sheet for the questionnaire belonging to that user. Replace the [username] tag with the applicable user name. It must be used in combination with the correct password tag shown below. Can also be used for an n=3 link to login during the creation. 
|-
| &p=[password] 
| Replace the [password] tag with correct password for the user used in the [username] tag. 
|}

 

== Return values for CgScript functions ==
{| class="wikitable"
|+
!Qnaire Impersonation
!already logged in
!link type
![[User_getQasUser]]
![[User_getLoggedInUser]]
![[User getCallingLoggedInUser]]
![[getCurrentUserResourceId]]
|-
| rowspan="10" |No
| rowspan="5" |No
|Direct
|Qas user
|Qas user
|Empty
|Qas user
|-
|Direct Anon Qas
|Empty
|anonymous (userId: 4)
|Empty
|anonymous (userId: 4)
|-
|n=1
|Empty
|anonymous (userId: 4)
|Empty
|anonymous (userId: 4)
|-
|n=2
|User C
|User C
|Empty
|User C
|-
|n=3
| colspan="4" |Don't work when NO logged in before, will show login page
|-
| rowspan="5" |User B
|Direct
|Qas user
|Qas user
|User B
|Qas user
|-
|Direct Anon Qas
|Empty
|anonymous (userId: 4)
|User B
|anonymous (userId: 4)
|-
|n=1
|Empty
|anonymous (userId: 4)
|User B
|anonymous (userId: 4)
|-
|n=2
|User C
|User C
|User B
|User C
|-
|n=3
|User B
|User B
|User B
|User B
|-
| rowspan="10" |User A
| rowspan="5" |No
|Direct
|Qas user
|Qas user
|Empty
|User A
|-
|Direct Anon Qas
|Empty
|anonymous (userId: 4)
|Empty
|User A
|-
|n=1
|Empty
|anonymous (userId: 4)
|Empty
|User A
|-
|n=2
|User C
|User C
|Empty
|User A
|-
|n=3
| colspan="4" |Don't work when NO logged in before, will show login page
|-
| rowspan="5" |User B
|Direct
|Qas user
|Qas user
|User B
|User A
|-
|Direct Anon Qas
|Empty
|anonymous (userId: 4)
|User B
|User A
|-
|n=1
|Empty
|anonymous (userId: 4)
|User B
|User A
|-
|n=2
|User C
|User C
|User B
|User A
|-
|n=3
|User B
|User B
|User B
|User A
|}
[[Category:Handling_answer_sheets_and_samples]]

QcsCatiContactColumn class

2026-09-20T06:41:12Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsCatiContactColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with cati data.</nowiki>
|InheritsFrom=QcsColumn|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QcsGenericWeightColumn class

2026-09-20T06:40:15Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsGenericWeightColumn</nowiki>
|Description=<nowiki>Represents a data cache specification weight column. For manipulation and more info see DataCacheSpecificationWeightColumn class.</nowiki>
|InheritsFrom=QcsColumn|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QcsGroupColumn class

2026-09-20T06:39:21Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsGroupColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with group data.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Set the associated group.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new boolean column true if the user for a row belongs to the given group.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>GroupResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the group used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

=== '''Examples''' ===
 Add a new group column named "ccGroup" to an existing DCS
<source lang="javascript">
number groupResourceId = 15638274;
DataCacheSpecification dcs = new DataCacheSpecification(15641385);
QcsGroupColumn groupcolumn = new QcsGroupColumn ("ccGroup", groupResourceId, dcs);
groupcolumn.Save();
dcs.Save();
dcs.Rebuild();

</source>
Result true if the user for a row belongs to the given group.

[[File:2018-11-07_15-31-46.png]]

QcsPhoneColumn class

2026-09-20T06:38:01Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsPhoneColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with phone number data.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>phoneType</nowiki>|Description=<nowiki>Set phone type.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new phone column for the padata cache specification.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>PhoneType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the phone type of the QcsPhone column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

=== '''Note''' ===
<source lang="javascript">
//Phone type:
0: NotIdentified
1: Home1
2: Home2
3: Mobile1
4: Mobile2
5: Business1
6: Business2
7: HomeFax
8: BusinessFax
9: Main1
10: Main2
11: Fax1
12: Fax2
</source>
=== '''Examples''' ===
<source lang="javascript">
string columnName = "NotIdentified";
number phoneType = 0;
DataCacheSpecification dcs = new DataCacheSpecification(15567446);
QcsPhoneColumn phone = new QcsPhoneColumn(columnName, phoneType, dcs);
phone.Save();
dcs.Save();
</source>

[[File:Phone1.png]]
[[File:Phone2.png]]

QcsQuestionColumn class

2026-09-20T06:36:49Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsQuestionColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with data from collected questions.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set the name of the column in the dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column with an explicit name.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AnswerOptionIndex</nowiki>|HasGetter=1|Description=<nowiki>Get which answer option is used for this column. -1 if not from answer option.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>OpenPart</nowiki>|HasGetter=1|Description=<nowiki>Get if this column is the open part of the question.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuestionLabel</nowiki>|HasGetter=1|Description=<nowiki>Get the questionlabel used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the questionnaire used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SubQuestionIndex</nowiki>|HasGetter=1|Description=<nowiki>Get which sub question is used for this column. -1 if not from subquestion.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

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

'''Ex: Create question columns for Primary qnaire'''

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

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

for(number i= 0; i < aQcsQuestionColumns.Count; i++){
aQcsQuestionColumns[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>

'''Ex: Copy all question columns from DCS A to DCS B'''
<source lang="javascript">
// Copy all question columns from DCS A to DCS B
number dcsARId = 15645155;
number dcsBRId = 15645157;
number qnaireARId = 15645137;

DataCacheSpecification dcsA = new DataCacheSpecification(dcsARId);
DataCacheSpecification dcsB = new DataCacheSpecification(dcsBRId);

dcsB.Reset();
dcsB.ClearSecondaryQuestionnaireJoinType();
dcsB.SetSecondaryQuestionnaireJoinType (qnaireARId,"CompanyNumber","CompanyNumber");
array arrayQuestionColumns = dcsA.CreateAllColumnsForAllQuestions(0);
for(number i = 0; i<arrayQuestionColumns.Count; i++)
{
QcsQuestionColumn questionColumn = arrayQuestionColumns[i];
questionColumn.ChangeDcs(dcsB);
questionColumn.Save();
}
dcsB.Save();
dcsB.Rebuild(true,true,0);
</source>

QcsSampleRuleColumn class

2026-09-20T06:35:42Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsSampleRuleColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with sample rule data.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>sampleRuleResourceId</nowiki>|Description=<nowiki>Set the associated sample rule.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>sampleRuleResourceId</nowiki>|Description=<nowiki>Set the associated sample rule.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set the name of the column in the dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column with an explicit name.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the questionnaire used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the sample rule used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}
[[File:2018-11-07_16-09-57.png]]

QcsTableColumn class

2026-09-20T06:34:59Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsTableColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with data from other tables.</nowiki>
|InheritsFrom=QcsColumn|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

QcsUserColumn class

2026-09-20T06:34:03Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsUserColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with user data.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userColumn</nowiki>|Description=<nowiki>The column name from the user table to get data from.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column with user data.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>UserColumnName</nowiki>|HasGetter=1|Description=<nowiki>Get the column in the user table used for getting data for this column.</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15639274);
QcsUserColumn userColumn = new QcsUserColumn("ResourceId" ,dcs);
userColumn.Save();
dcs.Save();
</source>
[[File:2018-08-22_13-56-12.png]]

QcsCustomColumn class

2026-09-20T06:31:09Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsCustomColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with data calculated from script.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>dataType</nowiki>|Description=<nowiki>Set the data type the script will return (notice this is CgScript type, not DCS type)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isFullColumn</nowiki>|Description=<nowiki>Does the script evaluate the whole column at a time or not</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new boolean column true if the user for a row belongs to the given group.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetAsPii</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isPii</nowiki>|Description=<nowiki>True if PII and can access other pii columns</nowiki>}}
|Description=<nowiki>Declare whether this custom column contains PII</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsFullColumn</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Does the script evaluate the whole column at a time or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

=== '''Examples''' ===
Create custom column
<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("test", "number", false, dcs);
cc.CgScript = "if(Q1!=empty) return Q1; else return 1;";
cc.Save();
dcs.Save();
</source>
[[File:2018-08-13_10-18-03.png]]

Create custom full column
<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("testfullcustom", "number", true, dcs);
cc.CgScript = "
array result = {};
number numberOfRow = Id.Count;
for(number i = 0; i < numberOfRow; i++) {
if (Q1[i] != empty)
result.Add(Q1[i]);
else result.Add(1);
}
return result;
";
cc.Save();
dcs.Save();
</source>

Create custom full column using fs.UpdatedNumberOfRows
<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("testfullcustom", "number", true, dcs);
cc.CgScript = "
array param = Workflow_getParameters();
Dictionary localCache = param[0];
FullCustomColumnSettings fs = param[1];
array result = {};
number numberOfRow = fs.UpdatedNumberOfRows;
for(number i = 0; i < numberOfRow; i++) {
if (Q1[i] != empty)
result.Add(Q1[i]);
else result.Add(1);
}
return result;
";
cc.Save();
dcs.Save();
</source>

QcsColumn class

2026-09-20T06:29:23Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsColumn</nowiki>
|Description=<nowiki>Represents a questionnaire cache specification column.</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}
[[Category:QcsColumn]]

QcsQasColumn class

2026-09-20T06:28:05Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>QcsQasColumn</nowiki>
|Description=<nowiki>Represents a data cache specification column with Qas data.</nowiki>
|InheritsFrom=QcsColumn|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionnaireColumn</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column.</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionnaireColumn</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set the name of the column in the dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=<nowiki>Create a new column with an explicit name.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</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>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuestionnaireColumnName</nowiki>|HasGetter=1|Description=<nowiki>Get the column in the qas table used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the questionnaire used for getting data for this column.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

DataCacheSpecification class

2026-09-20T05:40:07Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>DataCacheSpecification</nowiki>
|Description=<nowiki>Represents a DataCache specification.</nowiki>
|InheritsFrom=object|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=Empty|Name=<nowiki>ClearFilter</nowiki>|Description=<nowiki>Remove all filters from the DataCache</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ClearSecondaryQuestionnaireJoinType</nowiki>|Description=<nowiki>Delete all the secondary questionnaires which are joined with the primary</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=bool|Name=<nowiki>DeleteSecondaryQuestionnaireJoinType</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>secondaryQuestionnaireResourceId</nowiki>|Description=<nowiki>Which secondary questionnaire</nowiki>}}
|Description=<nowiki>Delete the secondary questionnaire which is joined with the primary</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. Consider using EvalWhereExps instead.</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. Consider using EvalWhereExps instead.</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. Consider using EvalWhereExps instead.</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. Consider using EvalWhereExps instead.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>EvalWhereExps</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>Dictionary of string keys to WhereExpFragment values.</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>EvalWhereExps</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>Dictionary of string keys to WhereExpFragment values.</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>EvalWhereExps</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>Dictionary of string keys to WhereExpFragment values.</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>EvalWhereExps</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>whereExpressions</nowiki>|Description=<nowiki>Dictionary of string keys to WhereExpFragment values.</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. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetAllSecondaryQuestionnaireJoinType</nowiki>|Description=<nowiki>Get all the secondary questionnaires that are joined with the primary</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>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forceFull</nowiki>|Description=<nowiki>Force a complete rebuild, even if dcs is configured for partial rebuilds</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>extraParameter</nowiki>|Description=<nowiki>If the dcs to build is built from a script it will get this as the 5th parameter</nowiki>}}
|Description=<nowiki>Rebuild the dcs. Notice this will commit the current transaction</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>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forceFull</nowiki>|Description=<nowiki>Force a complete rebuild, even if dcs is configured for partial rebuilds</nowiki>}}
|Description=<nowiki>Rebuild the dcs. Notice this will commit the current transaction</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>Rebuild</nowiki>|Description=<nowiki>Rebuild the dcs (true, true, -1). Notice this will commit the current transaction</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveFilter</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filterQuestionLabel</nowiki>|Description=<nowiki>Question to apply filter to. If empty, then clear current filters</nowiki>}}
|Description=<nowiki>Remove a filter from the DataCache</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>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AutoUpdate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Auto Update</nowiki>}}
{{CGscriptProperties_Template|ReturnType=AxisSet|Name=<nowiki>AxisSet</nowiki>|HasGetter=1|Description=<nowiki>Get info on axis in the dcs</nowiki>}}
{{CGscriptProperties_Template|ReturnType=object|Name=<nowiki>BuildUsingWorkflowScriptParameter</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set parameter that script gets as first parameter</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>BuildUsingWorkflowScriptResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set resource id of script to use for building full custom dcs</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=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the data cache contains columns classified as PII.</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. If empty then use default 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>PartialRebuild</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if dcs should only update QAS changed since last build</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|HasSetter=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>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Array of DataCacheSpecification|Name=<nowiki>DataCacheSpecification_getByParent</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource id of the parent to fetch all children dcs for</nowiki>}}
|Description=<nowiki>Get all children DCS</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>

 
'''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>

 
'''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>

 
'''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>

 
'''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>

 
'''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]]

Quota class

2026-08-28T03:33:54Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>Quota</nowiki>
|Description=<nowiki>The questionnaire's quota object.</nowiki>
|InheritsFrom=Array|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Quota resource id</nowiki>}}
|Description=<nowiki>Fetch exists quota</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Quota's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Questionnaire|Name=<nowiki>questionnaire</nowiki>|Description=<nowiki>The questionnaire contains this quota</nowiki>}}
|Description=<nowiki>Create and add new quota to questionnaire object</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>target</nowiki>|Description=<nowiki>Target count for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>expression</nowiki>|Description=<nowiki>CGScript expression for the quota</nowiki>}}
|Description=<nowiki>Create new quota in the current questionnaire context</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>target</nowiki>|Description=<nowiki>Target count for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>expression</nowiki>|Description=<nowiki>CGScript expression for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Create new quota in a specific questionnaire</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save quota</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Current</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of completed resource project questionnaires in the quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota description</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Disabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota disabled or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Expression</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota expression</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Quota resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>OnGoing</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of on going resource project questionnaires in the quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>OutsideTarget</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of outside target resource project questionnaires in the quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PreStratification</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota pre-stratification</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireId</nowiki>|HasGetter=1|Description=<nowiki>Resource id of questionnaire belong to</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuotaFull</nowiki>|HasGetter=1|Description=<nowiki>Gets the number of quota full resource project questionnaires in the quota</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Quota target</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TargetReached</nowiki>|HasGetter=1|Description=<nowiki>Gets information about whether or not the target for this quota has been reached</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_deleteAllQuotas</nowiki>|Description=<nowiki>Deletes all quotas from the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_deleteAllQuotas</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Deletes all quotas from the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_deleteQuota</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>}}
|Description=<nowiki>Deletes the quota with the given name from the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_deleteQuota</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Deletes the quota with the given name from the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Quota|Name=<nowiki>Quota_getAllQuotas</nowiki>|Description=<nowiki>Returns all quotas for the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Quota|Name=<nowiki>Quota_getAllQuotas</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Returns all quotas for the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Quota|Name=<nowiki>Quota_getQuotaByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>}}
|Description=<nowiki>Returns the quota with the given name in the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Quota|Name=<nowiki>Quota_getQuotaByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Returns the quota with the given name in the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Quota|Name=<nowiki>Quota_getQuotasByNameLike</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>}}
|Description=<nowiki>Returns quotas whose names contain the given string in the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Quota|Name=<nowiki>Quota_getQuotasByNameLike</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Returns quotas whose names contain the given string in the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Quota|Name=<nowiki>Quota_new</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Quota target</nowiki>|Description=<nowiki>Target count for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota expression</nowiki>|Description=<nowiki>CGScript expression for the quota</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a new quota object for the current questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Quota|Name=<nowiki>Quota_new</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Quota target</nowiki>|Description=<nowiki>Target count for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota expression</nowiki>|Description=<nowiki>CGScript expression for the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a new quota object for the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_save</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Quota|Name=<nowiki>Quota</nowiki>|Description=<nowiki>The quota to save</nowiki>}}
|Obsolete=1
|Description=<nowiki>Saves the quota object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Quota_targetReached</nowiki>|Description=<nowiki>Returns true if any quota has reached its target</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Quota_targetReached</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota to check</nowiki>}}
|Description=<nowiki>Returns true if the named quota has reached its target</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Quota_targetReached</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Returns true if any quota in the specified questionnaire has reached its target</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Quota_targetReached</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota to check</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Returns true if the named quota in the specified questionnaire has reached its target</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_updateAllQuotas</nowiki>|Description=<nowiki>Updates all quotas for the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Quota_updateAllQuotasForAllQASs</nowiki>|Description=<nowiki>Updates all quotas for all QASs in the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Quota_updateAllQuotasForAllQASs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Updates all quotas for all QASs in the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Quota_updateQuota</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>}}
|Description=<nowiki>Updates the specified quota</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Quota_updateQuotaForAllQASs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>}}
|Description=<nowiki>Updates the specified quota for all QASs in the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Quota_updateQuotaForAllQASs</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Quota name</nowiki>|Description=<nowiki>Name of the quota</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Quota questionnaire resource id</nowiki>|Description=<nowiki>The questionnaire resource id</nowiki>}}
|Description=<nowiki>Updates the specified quota for all QASs in the specified Questionnaire</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
//create quota for qnaire
Questionnaire qnaire = new Questionnaire (17148177);
Quota quota = new Quota ("Male", qnaire);
quota.Target = 100;
quota.Expression = "Gender == 1";
quota.Description = "xxxxx";
quota.Save();
</source>

AppProduct class

2025-09-09T07:39:58Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>AppProduct</nowiki>
|Description=<nowiki>Represents an AppProduct.</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=AppProductRole|Name=<nowiki>AddRole</nowiki>|Description=<nowiki>Add a new blank role</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Apply all changes to the AppProduct</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DevelopmentUrl</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the development URL</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Enabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the product is enabled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsSales</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if this is a sales product</nowiki>}}
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Name</nowiki>|HasGetter=1|Description=<nowiki>Get/set the localized name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Order</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the order</nowiki>}}
{{CGscriptProperties_Template|ReturnType=ResourceEdit|Name=<nowiki>ResourceModel</nowiki>|HasGetter=1|Description=<nowiki>Edit the Resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=CompatibilityArray|Name=<nowiki>Roles</nowiki>|HasGetter=1|Description=<nowiki>Get the list of roles</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SvgIcon</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the SVG icon content</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Url</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the product URL</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=AppProduct|Name=<nowiki>AppProduct_create</nowiki>|Description=<nowiki>Create a new AppProduct</nowiki>}}
{{CGscriptMethods_Template|ReturnType=AppProduct|Name=<nowiki>AppProduct_getById</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of the item to fetch</nowiki>}}
|Description=<nowiki>Fetch AppProduct by primary key. Returns Empty if not found</nowiki>}}
}}

TenantMapping class

2025-09-09T07:37:08Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>TenantMapping</nowiki>
|Description=<nowiki>Tenant mapping and parent folder for the tenant</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=TenantMappingRole|Name=<nowiki>AddRoleMapping</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>role</nowiki>|Description=<nowiki>The tenant role to add</nowiki>}}
|Description=<nowiki>Add blank Role mapping</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentFolder</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The parent folder id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=CompatibilityArray|Name=<nowiki>RoleMappings</nowiki>|HasGetter=1|Description=<nowiki>List of role mappings</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Tenant class

2025-09-09T07:35:43Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>Tenant</nowiki>
|Description=<nowiki>Represents a SsoTenant.</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddPasswordCompatTenantUsers</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>userRoles</nowiki>|Description=<nowiki>Dictionary of user id and array of roles</nowiki>}}
|Description=<nowiki>For backwards compatibility with username/password users, using this you can setup a user to belong to the current tenant with the given role list</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemovePasswordCompatTenantUsers</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>users</nowiki>|Description=<nowiki>User ids</nowiki>}}
|Description=<nowiki>Remove all fake tenant roles for the given user ids</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Apply all changes to the SsoTenant</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=TenantMapping|Name=<nowiki>Mapping</nowiki>|HasGetter=1|Description=<nowiki>Role mapping and parent folder for the tenant</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TenantOnboarding|Name=<nowiki>Onboarding</nowiki>|HasGetter=1|Description=<nowiki>Onboarding info for the tenant</nowiki>}}
{{CGscriptProperties_Template|ReturnType=ResourceEdit|Name=<nowiki>ResourceModel</nowiki>|HasGetter=1|Description=<nowiki>Edit the Resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TenantId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the tenant id - e.g. for Microsoft this is a guid</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Tenant|Name=<nowiki>Tenant_create</nowiki>|Description=<nowiki>Create a new SsoTenant</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Tenant|Name=<nowiki>Tenant_getById</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of the item to fetch</nowiki>}}
|Description=<nowiki>Fetch SsoTenant by primary key</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Tenant|Name=<nowiki>Tenant_getByTenantId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of the item to fetch</nowiki>}}
|Description=<nowiki>Fetch SsoTenant by tenant id</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
Tenant t = Tenant_getById(tenatId);
//t.AddPasswordCompatTenantUsers({userId: {"mapping"}});
t.AddPasswordCompatTenantUsers({20708200: {"agent-1"}});
t.Save();
</source>

ResourceEdit class

2025-08-26T03:32:24Z

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=<nowiki>ResourceEdit</nowiki> |Description=<nowiki>Generic class for editing resources</nowiki> |InheritsFrom=object|Methods= {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |Properties= {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CalculatedManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set c..."

{{CGscriptClass_Template
|Name=<nowiki>ResourceEdit</nowiki>
|Description=<nowiki>Generic class for editing resources</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CalculatedManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set calculated man hours flag</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasResourceTemplateId</nowiki>|HasGetter=1|Description=<nowiki>Indicates if resource can be templated</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InheritAccess</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set inherit access flag</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the parent resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set resource man hours</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set resource template id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ShortName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the resource short name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TimeregEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set timereg enabled flag</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
}}

Tenant class

2025-08-14T08:55:40Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>Tenant</nowiki>
|Description=<nowiki>Represents a SsoTenant.</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddPasswordCompatTenantUsers</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>userRoles</nowiki>|Description=<nowiki>Dictionary of user id and array of roles</nowiki>}}
|Description=<nowiki>For backwards compatibility with username/password users, using this you can setup a user to belong to the current tenant with the given role list</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemovePasswordCompatTenantUsers</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>users</nowiki>|Description=<nowiki>User ids</nowiki>}}
|Description=<nowiki>Remove all fake tenant roles for the given user ids</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Apply all changes to the SsoTenant</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=TenantMapping|Name=<nowiki>Mapping</nowiki>|HasGetter=1|Description=<nowiki>Role mapping and parent folder for the tenant</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TenantOnboarding|Name=<nowiki>Onboarding</nowiki>|HasGetter=1|Description=<nowiki>Onboarding info for the tenant</nowiki>}}
{{CGscriptProperties_Template|ReturnType=ResourceEdit|Name=<nowiki>ResourceModel</nowiki>|HasGetter=1|Description=<nowiki>Edit the Resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TenantId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the tenant id - e.g. for Microsoft this is a guid</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Tenant|Name=<nowiki>Tenant_create</nowiki>|Description=<nowiki>Create a new SsoTenant</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Tenant|Name=<nowiki>Tenant_getById</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of the item to fetch</nowiki>}}
|Description=<nowiki>Fetch SsoTenant by primary key. Returns Empty if not found</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
Tenant t = Tenant_getById(tenatId);
//t.AddPasswordCompatTenantUsers({userId: {"mapping"}});
t.AddPasswordCompatTenantUsers({20708200: {"agent-1"}});
t.Save();
</source>

Tenant class

2025-08-14T08:48:50Z

Nguyenduyan:

Questionnaire class

2025-08-14T08:40:12Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>Questionnaire</nowiki>
|Description=<nowiki>The questionnaire object.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire by id</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Qualified name of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire by name</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Questionnaire's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Resource parent's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>layoutId</nowiki>|Description=<nowiki>Questionnaire layout's id</nowiki>}}
|Description=<nowiki>Create new questionnaire with new questionnaire template and use default resource template</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Questionnaire's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Resource parent's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>layoutId</nowiki>|Description=<nowiki>Questionnaire layout's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>templateId</nowiki>|Description=<nowiki>Questionnaire template's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateId</nowiki>|Description=<nowiki>Resource tempalte's id of questionnaire. Set it's 0 to use default resource template</nowiki>}}
|Description=<nowiki>Create new questionnaire with exist template</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GetLink</nowiki>|Description=<nowiki>Get the url to participate in answering the questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RebuildSample</nowiki>|Description=<nowiki>Rebuild all sample rules in questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save questionnaire. It also save for new questionnaire template, sample rule, quota. For update, you should call save in specific object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>AutomaticCloseDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Automatic close date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>AutomaticReleaseDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Automatic release date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|HasGetter=1|Description=<nowiki>Average successful interview time</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Completed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire status completed or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserId</nowiki>|HasGetter=1|Description=<nowiki>User created this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>When this questionnaire created</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DevelopmentEndDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Development end date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DevelopmentStartDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Development start date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DisplayName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire name shown to respondents in their point list</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>EstimatedTotalTime</nowiki>|HasGetter=1|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Reosurce id of questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ImpersonationUserId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Run questionnaire context with permission of specific user. Set its value is 0 to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>LayoutId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire layout's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedByUserId</nowiki>|HasGetter=1|Description=<nowiki>User last updated this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Last time modify this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfActiveNotContacted</nowiki>|HasGetter=1|Description=<nowiki>Number of not started answer sheets which are related to active sample rules</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfActiveSample</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets that are related to existing sample rules and where these sample rules are active (you can deactivate sample rules in the CATI)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfAvailable</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets (both created via samples, from import, as well as through recurring links) that have not yet been answered.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfAvailableActive</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which are still active for answering. In other words the available answer sheets minus any sheets that have failed (user does not want to answer)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfCompleted</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which were completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfCompletedToday</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which were completed on current date (server time-zone)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|HasGetter=1|Description=<nowiki>Number of interviews carried out through CATI that were successful.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceededToday</nowiki>|HasGetter=1|Description=<nowiki>Number of interviews carried out through CATI that were successful on current date (server time-zone)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfNotContacted</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which have yet not been started</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfPartly</nowiki>|HasGetter=1|Description=<nowiki>Specifies the number of sample respondents that have partly answered the questionnaire (means they have at least clicked the link to open their personal version of the questionnaire)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfSample</nowiki>|HasGetter=1|Description=<nowiki>Total number of answer sheets related to the questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfTest</nowiki>|HasGetter=1|Description=<nowiki>Number of test answer sheets</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Parent resource's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QualifiedName</nowiki>|HasGetter=1|Description=<nowiki>Get qualified name of questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of Quota|Name=<nowiki>Quotas</nowiki>|HasGetter=1|Description=<nowiki>All quotas associated with questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource tempalte's id of questionnaire. Set it's 0 to use default resource template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of SampleRule|Name=<nowiki>SampleRules</nowiki>|HasGetter=1|Description=<nowiki>All sample rules associated with questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=QuestionnaireStatus constant|Name=<nowiki>Status</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire status. Use constant QUESTIONNAIRE_STATUS_xxx</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire target number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TemplateId</nowiki>|HasGetter=1|Description=<nowiki>Questionnaire template's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimeEstimateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire time estimate's id. Set its value is 0 to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TimeEstimateName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire time estimate's name. Set its value is empty to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Questionnaire|Name=<nowiki>Questionnaire_current</nowiki>|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
//create new qnaire and also new qnaireTemplate under
string qnaireName = "test";
number parentId = 17148135;
number layoutId = 15735155;
Questionnaire qnaire = new Questionnaire (qnaireName, parentId, layoutId);
qnaire.ResourceTemplateId = 11088801;
qnaire.Save();
</source>
<source lang="javascript">
//create new qnaire using existing qnaireTemplate
string qnaireName = "test";
number parentId = 17148135;
number layoutId = 15735155;
number qnaireTemplateId = 17148298;
number resourceTemplateId = 11088801;// set 0 to use the default
Questionnaire qnaire = new Questionnaire (qnaireName, parentId, layoutId, qnaireTemplateId, resourceTemplateId);
qnaire.Save();
</source>

Microsoft login Catglobe Admin

2025-07-28T10:44:50Z

Nguyenduyan:

[[Category:Guides]]
Documentation for Catglobe site admins:

= Setting up Sso =

== Prerequisites ==

You need to contact Catglobe support to enable your site for Entra login.

== Configuration steps ==

==== AppProducts ====

1. Setup AppProducts in your Catglobe site

You can access the AppProducts list from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> AppProducts

[[File:AppProduct1.png]]

Or via the url: yourCatglobeSite/Sso/Admin/AppProducts

Here you can see a create button, click on the button and follow the setup for your AppProduct

[[File:AppProduct2.png]]

2. Add Roles in your AppProduct

At Roles step, you can see an Add Role button, click on the button to start setup roles

[[File:AppProduct3.png]]

3. Add group membership for each role

While adding a role, you need to select a resource template and group membership. These will be assigned to the user when they login with Microsoft

[[File:AppProduct401.png]]

==== Tenants ====
1. Choose which external roles from the App Roles lists (See [[Microsoft_login|List of App Roles]]) should be given to your client.

E.g. one of your products requires some kind of agent. So you tell them:

Please map "Agent type 1" to the group of people you want to do "<agent like role>".

2. Send your client instructions about the login page and the list of roles they need to configure groups for.

3. Once the Admin has logged in once and registered the Tenant, you can find the Tenant in the list of Tenants under their email domain name.

You can access Tenants list from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> Tenants

[[File:Tenant1.png]]

Or via the URL: yourCatglobeSite/Sso/Admin/Tenants

4. Edit the Tenant to map the App roles to the desired list of AppProduct roles

Select the Tenant on the Tenants list, then click the Edit button

At the Role mapping step, map each role from the list you provided to the client, by selecting the corresponding key from the dropdown and clicking Add mapping

[[File:Tenant201_2.jpg]]

Then Click on “Add new role” to select corresponding roles from “AppProducts”

[[File:Tenant203.png]]

5. Their users can now click the 'Login with Microsoft' button on the login page and will get the roles they have assigned to them.

[[File:mslogin.png]]

File:Tenant203.png

2025-07-28T10:42:11Z

Nguyenduyan:

File:AppProduct401.png

2025-07-28T10:40:19Z

Nguyenduyan:

Microsoft login Customer Admin

2025-07-28T10:27:33Z

Nguyenduyan:

[[Category:Guides]]
Documentation for Customer admins:

= Configure your Entra to login to Catglobe =

Congratulations, instead of having to deal with usernames and password on your Catglobe based application you can now use Microsoft Entra login to access.

== Information you need ==

Your Catglobe contact should have given you:

1. The url to the Catglobe powered application.

2. A list of roles you need to give to your users

==== Configuration steps ====

1. Open the Url and click "Login with Microsoft".

[[File:mslogin.png]]

2. You should see a page informing you that your Tenant is new. Complete the registration process by clicking "Register".

[[File:regisTenant.png]]

3. If it says your tenant is already pending approval, someone else already did step 2.

4. The Catglobe application now appears in your list of Enterprise applications in your tenant configuration.

[[File:customeradmin102.png]]

5. Add groups as you desire and assign them a Catglobe App role as instructed.

[[File:customeradmin202.png]]

6. Add users to your groups.

7. Your users can now click the 'Login with Microsoft' button on the login page and will get the roles you have assigned to them.

[[File:mslogin.png]]

Microsoft login Catglobe Admin

2025-07-28T10:19:07Z

Nguyenduyan:

[[Category:Guides]]
Documentation for Catglobe site admins:

= Setting up Sso =

== Prerequisites ==

You need to contact Catglobe support to enable your site for Entra login.

== Configuration steps ==

==== AppProducts ====

1. Setup AppProducts in your Catglobe site

You can access the AppProducts list from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> AppProducts

[[File:AppProduct1.png]]

Or via the url: yourCatglobeSite/Sso/Admin/AppProducts

Here you can see a create button, click on the button and follow the setup for your AppProduct

[[File:AppProduct2.png]]

2. Add Roles in your AppProduct

At Roles step, you can see an Add Role button, click on the button to start setup roles

[[File:AppProduct3.png]]

3. Add group membership for each role

While adding a role, you need to select a resource template and group membership. These will be assigned to the user when they login with Microsoft

[[File:AppProduct44.png]]

==== Tenants ====
1. Choose which external roles from the App Roles lists (See [[Microsoft_login|List of App Roles]]) should be given to your client.

E.g. one of your products requires some kind of agent. So you tell them:

Please map "Agent type 1" to the group of people you want to do "<agent like role>".

2. Send your client instructions about the login page and the list of roles they need to configure groups for.

3. Once the Admin has logged in once and registered the Tenant, you can find the Tenant in the list of Tenants under their email domain name.

You can access Tenants list from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> Tenants

[[File:Tenant1.png]]

Or via the URL: yourCatglobeSite/Sso/Admin/Tenants

4. Edit the Tenant to map the App roles to the desired list of AppProduct roles

Select the Tenant on the Tenants list, then click the Edit button

At the Role mapping step, map each role from the list you provided to the client, by selecting the corresponding key from the dropdown and clicking Add mapping

[[File:Tenant201_2.jpg]]

Then Click on “Add new role” to select corresponding roles from “AppProducts”

[[File:Tenant202.png]]

5. Their users can now click the 'Login with Microsoft' button on the login page and will get the roles they have assigned to them.

[[File:mslogin.png]]

Microsoft login Catglobe Admin

2025-07-28T10:18:13Z

Nguyenduyan:

[[Category:Guides]]
Documentation for Catglobe site admins:

= Setting up Sso =

== Prerequisites ==

You need to contact Catglobe support to enable your site for Entra login.

== Configuration steps ==

==== AppProducts ====

1. Setup AppProducts in your Catglobe site

You can access AppProducts from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> AppProducts

[[File:AppProduct1.png]]

Or via the url: yourCatglobeSite/Sso/Admin/AppProducts

Here you can see a create button, click on the button and follow the setup for your AppProduct

[[File:AppProduct2.png]]

2. Add Roles in your AppProduct

At Roles step, you can see an Add Role button, click on the button to start setup roles

[[File:AppProduct3.png]]

3. Add group membership for each role

While adding a role, you need to select a resource template and group membership. These will be assigned to the user when they login with Microsoft

[[File:AppProduct44.png]]

==== Tenants ====
1. Choose which external roles from the App Roles lists (See [[Microsoft_login|List of App Roles]]) should be given to your client.

E.g. one of your products requires some kind of agent. So you tell them:

Please map "Agent type 1" to the group of people you want to do "<agent like role>".

2. Send your client instructions about the login page and the list of roles they need to configure groups for.

3. Once the Admin has logged in once and registered the Tenant, you can find the Tenant in the list of Tenants under their email domain name.

You can access Tenants list from the menu on your Catglobe site: ADMINISTRATION -> SINGLE-SIGN-ON -> Tenants

[[File:Tenant1.png]]

Or via the URL: yourCatglobeSite/Sso/Admin/Tenants

4. Edit the Tenant to map the App roles to the desired list of AppProduct roles

Select the Tenant on the Tenants list, then click the Edit button

At the Role mapping step, map each role from the list you provided to the client, by selecting the corresponding key from the dropdown and clicking Add mapping

[[File:Tenant201_2.jpg]]

Then Click on “Add new role” to select corresponding roles from “AppProducts”

[[File:Tenant202.png]]

5. Their users can now click the 'Login with Microsoft' button on the login page and will get the roles they have assigned to them.

[[File:mslogin.png]]

File:Tenant201 2.jpg

2025-07-28T10:16:21Z

Nguyenduyan:

File:Tenant201 1.jpg

2025-07-28T10:10:28Z

Nguyenduyan:

File:Tenant202.png

2025-07-28T09:49:42Z

Nguyenduyan:

File:Tenant201.png

2025-07-28T09:49:32Z

Nguyenduyan:

File:Tenant22.png

2025-07-28T09:49:20Z

Nguyenduyan:

File:Tenant2.png

2025-07-28T09:49:11Z

Nguyenduyan:

File:Tenant1.png

2025-07-28T09:49:02Z

Nguyenduyan:

File:RegisTenant.png

2025-07-28T09:48:49Z

Nguyenduyan:

File:Mslogin.png

2025-07-28T09:48:39Z

Nguyenduyan:

File:Customeradmin202.png

2025-07-28T09:48:29Z

Nguyenduyan:

File:Customeradmin201.png

2025-07-28T09:48:14Z

Nguyenduyan:

File:Customeradmin102.png

2025-07-28T09:47:51Z

Nguyenduyan:

File:Customeradmin101.png

2025-07-28T09:47:37Z

Nguyenduyan:

File:AppProduct44.png

2025-07-28T09:47:24Z

Nguyenduyan:

File:AppProduct3.png

2025-07-28T09:47:10Z

Nguyenduyan:

File:AppProduct2.png

2025-07-28T09:46:34Z

Nguyenduyan:

File:AppProduct1.png

2025-07-28T09:46:02Z

Nguyenduyan:

Script on Cati call

2025-06-26T09:45:57Z

Nguyenduyan:

[[Category:CATI_module]]
= Script on Cati call =
Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.
It should be noticed that the calling of this script is on the critical path, and must therefore be severely restricted in the amount of work done, ie in the case of sending SMS, the only thing the script should do is add respondent to a group and another script scheduled to run e,g. every 30 min takes care of the actual sending of SMS.

The script gets the following parameters:

1. The current cati contact in same format as returned from [[CATI_getCATIContacts]]

2. Times called

The current user context is set to the user of the qas, and the qas context is the dialed qas.

== Setup ==
Define "Script to execute after call" at CATI setting on Fieldwork management:

[[File:2018-05-23_15-25-57.png]]

Script on Workflow:

<source lang="javascript">
//Example script to add/remove the user to/from a group
array a = Workflow_getParameters();
array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
number timesCalled = a[1];
//QAS qas = QAS_getCurrentQAS();//The qas context is the dialed qas
User user = User_getQasUser();//The current user context is set to the user of the qas
number maxCallLimit = 5;//your limit
if(timesCalled >= maxCallLimit){
Group_addUser(user.ResourceId, groupAdd) ;//yourGroup
Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup
}
</source>

[[File:2018-05-23_15-39-30.png]]

Please note that if the code has an error, it will not be thrown; Cati will continue to call normally.
If you want to catch errors, you should use a try-catch block and send the error back to yourself.

<source lang="javascript">
object e;
try{
//do something
}catch(e){
sendEmail("yourEmail","Alias","Subject",e.Message,"fromEmail");
}
</source>

Script on Cati call

2025-06-26T09:43:12Z

Nguyenduyan:

[[Category:CATI_module]]
= Script on Cati call =
Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.
It should be noticed that the calling of this script is on the critical path, and must therefore be severely restricted in the amount of work done, ie in the case of sending SMS, the only thing the script should do is add respondent to a group and another script scheduled to run e,g. every 30 min takes care of the actual sending of SMS.

The script gets the following parameters:

1. The current cati contact in same format as returned from [[CATI_getCATIContacts]]

2. Times called

The current user context is set to the user of the qas, and the qas context is the dialed qas.

== Setup ==
Define "Script to execute after call" at CATI setting on Fieldwork management:

[[File:2018-05-23_15-25-57.png]]

Script on Workflow:

<source lang="javascript">
//Example script to set disable user who reach max call and remove the user from a group
array a = Workflow_getParameters();
array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
number timesCalled = a[1];
//QAS qas = QAS_getCurrentQAS();//The qas context is the dialed qas
User user = User_getQasUser();//The current user context is set to the user of the qas
number maxCallLimit = 5;//your limit
if(timesCalled >= maxCallLimit){
Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup
//Group_addUser(user.ResourceId, groupAdd) ;//yourGroup
user.Disabled = true;
user.Save();
}
</source>

[[File:2018-05-23_15-39-30.png]]

Please note that if the code has an error, it will not be thrown; Cati will continue to call normally.
If you want to catch errors, you should use a try-catch block and send the error back to yourself.

<source lang="javascript">
object e;
try{
//do something
}catch(e){
sendEmail("yourEmail","Alias","Subject",e.Message,"fromEmail");
}
</source>

Script on Cati call

2025-06-26T09:25:34Z

Nguyenduyan:

[[Category:CATI_module]]
= Script on Cati call =
Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.
It should be noticed that the calling of this script is on the critical path, and must therefore be severely restricted in the amount of work done, ie in the case of sending SMS, the only thing the script should do is add respondent to a group and another script scheduled to run e,g. every 30 min takes care of the actual sending of SMS.

The script gets the following parameters:

1. The current cati contact in same format as returned from [[CATI_getCATIContacts]]

2. Times called

The current user context is set to the user of the qas, and the qas context is the dialed qas.

== Setup ==
Define "Script to execute after call" at CATI setting on Fieldwork management:

[[File:2018-05-23_15-25-57.png]]

Script on Workflow:

<source lang="javascript">
//Example script to set disable user who reach max call and remove the user from a group
array a = Workflow_getParameters();
array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
number timesCalled = a[1];
//QAS qas = QAS_getCurrentQAS();//The qas context is the dialed qas
User user = User_getQasUser();//The current user context is set to the user of the qas
number maxCallLimit = 5;//your limit
if(timesCalled >= maxCallLimit){
Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup
//Group_addUser(user.ResourceId, groupAdd) ;//yourGroup
user.Disabled = true;
user.Save();
}
</source>

[[File:2018-05-23_15-39-30.png]]

Script on Cati call

2025-06-26T09:14:57Z

Nguyenduyan:

[[Category:CATI_module]]
= Script on Cati call =
Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.
It should be noticed that the calling of this script is on the critical path, and must therefore be severely restricted in the amount of work done, ie in the case of sending SMS, the only thing the script should do is add respondent to a group and another script scheduled to run e,g. every 30 min takes care of the actual sending of SMS.

The script gets the following parameters:

1. The current cati contact in same format as returned from [[CATI_getCATIContacts]]

2. Times called

The current user context is set to the user of the qas, and the qas context is the dialed qas.

== Setup ==
Define "Script to execute after call" at CATI setting on Fieldwork management:

[[File:2018-05-23_15-25-57.png]]

Script on Workflow:

<source lang="javascript">
//Example script to set disable user who reach max call and remove the user from a group
array a = Workflow_getParameters();
array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
number timesCalled = a[1];
//QAS qas = QAS_getCurrentQAS();//The qas context is the dialed qas
User user = User_getQasUser();//The current user context is set to the user of the qas
number maxCallLimit = 5;//your limit
if(timesCalled >= maxCallLimit){
Group_removeUser(user.ResourceId, groupId) ;//yourGroup
user.Disabled = true;
user.Save();
}
</source>

[[File:2018-05-23_15-39-30.png]]

Make oidc work with respondents auth with guid only

2025-04-22T06:56:38Z

Nguyenduyan:

To automatically direct respondents to an external site (which is already authenticated by Catglobe) upon clicking the survey link, bypassing a login prompt, we can proceed as follows:

Input the cgscript on gateway workflow or on the questionnaire dummy:
<source lang="javascript">
//Script for gateway
return oidc_site + "authentication/login?respondent=" + User_getQasUser().ResourceGuid + "&respondent_secret=" + QAS_getCurrentQAS().AccessCode;
//Script for dummy
sendToUrl(oidc_site + "authentication/login?respondent=" + User_getQasUser().ResourceGuid + "&respondent_secret=" + QAS_getCurrentQAS().AccessCode);
</source>

Then send invitation mail to respondents. When a respondent clicks on survey link in mail, they'll be redirected to external site and automatically logged in.

Here's the flow diagram, to shows how this works

[[File:Oidc_authR.jpg]]
[[Category:Guides]]

ImportManager class

2025-04-14T05:28:07Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>ImportManager</nowiki>
|Description=<nowiki>Import data and users.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>Headers</nowiki>|Description=<nowiki>A list of string that are the header names</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>data</nowiki>|Description=<nowiki>Data to import. An array of arrays of equal length as the headers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>advancedMode</nowiki>|Description=<nowiki>Enable setting advanced settings - Requires special navigation access</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Group to add users to new users to and/or sample rule. Set to 0 to not add to group</nowiki>}}
|Description=<nowiki>Make a new import with the given data</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetPossibleAutoMasForData</nowiki>|Description=<nowiki>Get default automaps. First value is column name, second is actual import field</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetPossibleAutoMasForUser</nowiki>|Description=<nowiki>Get default automaps. First value is column name, second is actual import field</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>Import</nowiki>|Description=<nowiki>Run the Import. Note that this will commit any pending changes</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>SetDataImportOptions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>projectQuestionnaireResourceId</nowiki>|Description=<nowiki>The resource Id of where the data should be added/updated</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>type</nowiki>|Description=<nowiki>How to treat when already have existing answer sheets. 1 for Zero or One AnswerSheet, 2 for delete existing and create new, 3 for mapping to rpqIdColumnName</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>idColumnName</nowiki>|Description=<nowiki>Mapping for column name in case type is 3 or 4</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isCommaSeparatedFormat</nowiki>|Description=<nowiki>Import multi questions as comma separated format</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
|Description=<nowiki>Set specific options for importing data or altering existing data</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetDefaultNewUser</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>languageIso</nowiki>|Description=<nowiki>Default language</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>cultureIso</nowiki>|Description=<nowiki>Default culture</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>currency</nowiki>|Description=<nowiki>Default currency</nowiki>}}
|Description=<nowiki>Defaults for new users. If empty or not set, uses the global defaults</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUserImportOptions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userIdColumnName</nowiki>|Description=<nowiki>The header name of the userId column</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>userNameMask</nowiki>|Description=<nowiki>The mask used to create new usernames - an advanced setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>generatePasswords</nowiki>|Description=<nowiki>OBSOLETE. Always false. Generate passwords during import</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importUserInfo</nowiki>|Description=<nowiki>Import or Update users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPhoneNumber</nowiki>|Description=<nowiki>Import or Update phonenumbers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importAddress</nowiki>|Description=<nowiki>Import or Update addresses</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPoints</nowiki>|Description=<nowiki>Import or Update points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importQualification</nowiki>|Description=<nowiki>Import or Update qualifications</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>permissions</nowiki>|Description=<nowiki>Determine which groups should have access to the new users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
|Description=<nowiki>OBSOLETE. Use the new overload with parentResourceId.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>SetUserImportOptions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>userIdColumnName</nowiki>|Description=<nowiki>The header name of the userId column</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>userNameMask</nowiki>|Description=<nowiki>The mask used to create new usernames - an advanced setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>generatePasswords</nowiki>|Description=<nowiki>OBSOLETE. Always false. Generate passwords during import</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importUserInfo</nowiki>|Description=<nowiki>Import or Update users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPhoneNumber</nowiki>|Description=<nowiki>Import or Update phonenumbers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importAddress</nowiki>|Description=<nowiki>Import or Update addresses</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importPoints</nowiki>|Description=<nowiki>Import or Update points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>importQualification</nowiki>|Description=<nowiki>Import or Update qualifications</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Resource Id of the parent of the new users. Ignored if updating users</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>mapping</nowiki>|Description=<nowiki>Mapping between header names and import names. If empty, automapping is used</nowiki>}}
|Description=<nowiki>Set specific options for importing new users or altering existing users</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Description=<nowiki>Same as Validate(true)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>Validate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>errorOnSemiOpenQuestion</nowiki>|Description=<nowiki>Set to false if you need to import to questions with open parts and know that it may partially delete existing data</nowiki>}}
|Description=<nowiki>Validate prior to actual importing. Throws if errors, otherwise returns warning.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Culture</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the culture used during import in case we don't want to use the logged-in-user's one (UseLoggedInUsersCultureDuringImport = false)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Language</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the language used when importing text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>UseLoggedInUsersCultureDuringImport</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the culture used during import is the same as the logged in user or invariant culture. Default is invariant</nowiki>}}
}}

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

<source lang="javascript">
// EX for making import qnaire data without user (acreate new qas with no user)
array Headers={"Q2","Q4","Q5","TextValue","NumberValue"};
array Data={{1,"q4",1,"Text1",1}};
Bool advancedMode=false;
number groupResourceId =0;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
number qnaireRId = 15546533;
number type=1;
string rpqIdColumnName="";
bool isCommaSeparatedFormat = true;
Dictionary mapping = new Dictionary();
iM.SetDataImportOptions(qnaireRId,type,rpqIdColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source>

 <source lang="javascript">
//EX for import data to an existing answer sheet
array Headers={"RPQId","Q2","Q4","Q5","TextValue","NumberValue"};
array Data={{1742872963,1,"q4",1,"Text1",1}};
Bool advancedMode=false;
number groupResourceId =0;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
number qnaireRId = 15546533;
number type=3;
string rpqIdColumnName="RPQId";
bool isCommaSeparatedFormat = true;
Dictionary mapping = new Dictionary();
iM.SetDataImportOptions(qnaireRId,type,rpqIdColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source>

 <source lang="javascript">
//EX for import new user info and phone number
array Headers={"First name","Last name","User_Email","Language","Culture","PhoneType_NotIdentified","User_CountryCode"};
array Data={{"TestFirstName","TestLastName","so@testmail.com","da-DK","da-DK","12345678","dk"}};
Bool advancedMode=false;
number groupResourceId =15548117;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
string userIdColumnName="";
string userNameMask="";
bool generatePasswords=true;
bool importUserInfo = true;
bool importPhoneNumber = true;
bool importAddress=false;
bool importPoints =false;
bool importQualification=false;
number parentResourceId= 15546533;
Dictionary mapping = new Dictionary();
iM.SetUserImportOptions(userIdColumnName,userNameMask,generatePasswords,importUserInfo,importPhoneNumber,importAddress,importPoints,importQualification,parentResourceId,mapping);
iM.Validate();
iM.Import();
</source>

 <source lang="javascript">
//EX for importing new user and new qas
array Headers={"First name","Last name","User_Email","Language","Culture","PhoneType_NotIdentified","User_CountryCode","Q2","Q4","Q5","TextValue","NumberValue"};
array Data={{"TestFirstName","TestLastName","so@testmail.com","da-DK","da-DK","12345678","dk",1,"q4",1,"Text1",1}};
Bool advancedMode=false;
number groupResourceId =15548117;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
string userIdColumnName="";
string userNameMask="";
bool generatePasswords=true;
bool importUserInfo = true;
bool importPhoneNumber = true;
bool importAddress=false;
bool importPoints =false;
bool importQualification=false;
number parentResourceId= 15546533;
Dictionary mapping = new Dictionary();
iM.SetUserImportOptions(userIdColumnName,userNameMask,generatePasswords,importUserInfo,importPhoneNumber,importAddress,importPoints,importQualification,parentResourceId,mapping);
number qnaireRId = 15546533;
number type=1;
string rpqIdColumnName="";
bool isCommaSeparatedFormat = true;
//Dictionary mapping = new Dictionary();
iM.SetDataImportOptions(qnaireRId,type,rpqIdColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source> <source lang="javascript">
//Using SetDefaultNewUser
array Headers={"First name","Last name","User_Email"};
array Data={{"TestFirstName","TestLastName","so@testmail.com"}};
Bool advancedMode=false;
number groupResourceId =15548117;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
string userIdColumnName="";
string userNameMask="";
bool generatePasswords=true;
bool importUserInfo = true;
bool importPhoneNumber = true;
bool importAddress=false;
bool importPoints =false;
bool importQualification=false;
number parentResourceId= 15546533;
Dictionary mapping = new Dictionary();
iM.SetUserImportOptions(userIdColumnName,userNameMask,generatePasswords,importUserInfo,importPhoneNumber,importAddress,importPoints,importQualification,parentResourceId,mapping);
string languageIso="da-DK";
string cultureIso="da-DK";
string currency="USD";
iM.SetDefaultNewUser(languageIso, cultureIso,currency );
iM.Validate();
iM.Import();

</source> <source lang="javascript">
//Update an existing user
array Headers={"userId","Language","Culture","Currency"};
array Data={{"90414076","da-DK","da-DK","USD"}};
Bool advancedMode=false;
number groupResourceId =15548117;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
string userIdColumnName="userId";
string userNameMask="";
bool generatePasswords=true;
bool importUserInfo = true;
bool importPhoneNumber = true;
bool importAddress=false;
bool importPoints =false;
bool importQualification=false;
number parentResourceId= 15546533;
Dictionary mapping = new Dictionary();
iM.SetUserImportOptions(userIdColumnName,userNameMask,generatePasswords,importUserInfo,importPhoneNumber,importAddress,importPoints,importQualification,parentResourceId,mapping);
iM.Validate();
iM.Import();
</source>
 <source lang="javascript">
//update an existing qas by CustomerId (using SetDataImportOptions with type 4)
//CustomerID must be a text field, not numeric
array Headers={"CustomerID","Q1","Age"};
array Data={{"AB123",2,1}};
Bool advancedMode=false;
number groupResourceId =0;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
number qnaireRId = 15562388;
number type=4;
string idColumnName="CustomerID";
bool isCommaSeparatedFormat = true;
Dictionary mapping = new Dictionary();
iM.SetDataImportOptions(qnaireRId,type,idColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source>

<source lang="javascript">
//Set culture while import. If not set will use "." format, example: "45.967"
//Set Culture work combine with UseLoggedInUsersCultureDuringImport=false
array Headers={"qNumber"};
array Data={{"45,967"}};
Bool advancedMode=false;
number groupResourceId =0;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
number qnaireRId = 15636598;
number type=1;
string rpqIdColumnName="";
bool isCommaSeparatedFormat = true;
Dictionary mapping = new Dictionary();
//iM.UseLoggedInUsersCultureDuringImport=false;
iM.Culture = "da-DK";
iM.SetDataImportOptions(qnaireRId,type,rpqIdColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source>

<source lang="javascript">
//set language while import. If don't set, will use login user language
array Headers={"RPQ_StartDato","RPQ_SlutDato","RPQ_Status", "Q1"};
array Data={{"2018-06-18 02:49:06","2018-06-18 02:51:44","Successfuldt interview", "1"}};
Bool advancedMode=true;
number groupResourceId =0;
ImportManager iM = new ImportManager (Headers, Data, advancedMode, groupResourceId);
number qnaireRId = 15636646;
number type=1;
string rpqIdColumnName="";
bool isCommaSeparatedFormat = true;
Dictionary mapping = new Dictionary();
iM.Language = "da-DK";
iM.SetDataImportOptions(qnaireRId,type,rpqIdColumnName,isCommaSeparatedFormat,mapping);
iM.Validate();
iM.Import();
</source>