Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=QuestionnaireBatchJob |Description=Process each QAS with some custom logic in a optimal way. |InheritsFrom=object|Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=int|Name=questionnaireId|Description=Id of the base questionnaire}} |Description=Process each QAS with some custom logic in a optimal way.}} |Methods= {..."

2025-04-03T08:41:27Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>QuestionnaireBatchJob</nowiki> |Description=<nowiki>Process each QAS with some custom logic in a optimal way.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>Id of the base questionnaire</nowiki>}} |Description=<nowiki>Process each QAS with some custom logic in a optimal way.</nowiki>}} |Methods= {..."

New page

{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireBatchJob</nowiki>
|Description=<nowiki>Process each QAS with some custom logic in a optimal way.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>Id of the base questionnaire</nowiki>}}
|Description=<nowiki>Process each QAS with some custom logic in a optimal way.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AttachQuestionnaire</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>Id of the questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>latestOnly</nowiki>|Description=<nowiki>If user has multiple qas, only include last created or error</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>completedOnly</nowiki>|Description=<nowiki>Limit by qas that is completed</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question to load</nowiki>}}
|Description=<nowiki>Load readonly question from another questionnaire based on UserId</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AttachQuestionnaire</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>Id of the questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>latestOnly</nowiki>|Description=<nowiki>If user has multiple qas, only include last created or error</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>completedOnly</nowiki>|Description=<nowiki>Limit by qas that is completed</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>questionLabel</nowiki>|Description=<nowiki>Label of the question to load</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>alias</nowiki>|Description=<nowiki>Alias to use in execute parameter naming</nowiki>}}
|Description=<nowiki>Load readonly question from another questionnaire based on UserId with an alias</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Execute</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Function|Name=<nowiki>runner</nowiki>|Description=<nowiki>The function called for each QAS - parameter names infers which questions to load</nowiki>}}
|Description=<nowiki>Run the batch job - implicitly saves all modified question data</nowiki>}}
{{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>CompletedOnly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set Limit by qas that is completed. Default true</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CurrentCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set current qas to completed or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CurrentId</nowiki>|HasGetter=1|Description=<nowiki>Get current qas id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CurrentIsTest</nowiki>|HasGetter=1|Description=<nowiki>Get current qas is test qas</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeTest</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if include test qas. Default false</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>LatestOnly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set If user has multiple qas, only include last created or all. Default false</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>}}
}}
=== <span style="color:#DF8621">'''Examples'''</span> ===
For instance, we have the cgscript, run in batch mode before, like this:

[[File:2025-01-06_12-24-11.jpg]]

With new Qnaire workflow prompt, to run batch script, just do as follow:
* Open the Workflow prompt in Qnaire as normal (on questionnaire list, select a questionnaire, then click on menu '''Tool/Workflow script''' to open questionnaire workflow prompt):
Default script will be displayed to guide how to use QuestionnaireBatchJob class
* Replace the default script with your own script as necessary.
* Click Execute to run script

[[File:2025-01-06_13-54-36.jpg]]

So, the script run batch mode above should be updated to use QuestionnaireBatchJob class, looks like this:
<source lang="js">
QuestionnaireBatchJob batch = new QuestionnaireBatchJob(0);
//batch.LatestOnly = false;
//batch.CompletedOnly = true;
//batch.IncludeTest = false;
array errorQAS;
batch.Execute(function(Question Q100_Relation_New, Question Q6_Awareness){
QAS qas = new QAS(batch.CurrentId);
if(qas.Status == 5){
if(Q100_Relation_New[5] == empty && Q6_Awareness == [34]){
errorQAS.Add(batch.CurrentId);
}
}
});
print(errorQAS.Count);
print(errorQAS);
</source>

QuestionnaireBatchJob class - Revision history