Catglobe Wiki - User contributions [en]

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>

Make oidc work with respondents auth with guid only

2025-04-03T10:21:45Z

Nguyenduyan:

If we want to automatically link respondents to an external site (oidc_site) that uses authentication from Catglobe, without making them log in. Here's how we can do:

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

Workflow setGlobal

2025-04-03T09:24:42Z

Nguyenduyan:

==== Workflow_setGlobal====
Set values for scripts invoked from [[WorkflowScript_class]]

====== Syntax======
Workflow_setGlobal(string parameterName, AnyType value)
====== Return type ======
Empty
====== Examples ======

<source lang="javascript">
Workflow_setGlobal("x", 1000);
//Get global value on dynamic script
string script = "
number a = 1;
return a + Workflow_getGlobal(\"x\");
";
WorkflowScript wfS = new WorkflowScript (script, false);
wfS.Call();//1001
//Get global value on existing wokflow
wfS = new WorkflowScript (wf);
wfS.Call();//1002

/*
script on the above wf:
number a = 2;
return a + Workflow_getGlobal("x");
*/
</source>

[[Category:General_Functions]]

Workflow getGlobal

2025-04-03T09:23:50Z

Nguyenduyan:

==== Workflow_getGlobal====
Get values for scripts invoked from [[WorkflowScript_class]]

====== Syntax======
Workflow_getGlobal(string parameterName)
====== Return type ======
AnyType
====== Examples ======

<source lang="javascript">
Workflow_setGlobal("x", 1000);
//Get global value on dynamic script
string script = "
number a = 1;
return a + Workflow_getGlobal(\"x\");
";
WorkflowScript wfS = new WorkflowScript (script, false);
wfS.Call();//1001
//Get global value on existing wokflow
wfS = new WorkflowScript (wf);
wfS.Call();//1002

/*
script on the above wf:
number a = 2;
return a + Workflow_getGlobal("x");
*/
</source>

[[Category:General_Functions]]

DateTime fromJson

2025-04-03T09:22:28Z

Nguyenduyan:

==== DateTime_fromJson====
Convert DateTime string Json to [[DateTime_class]]
======Syntax======
DateTime_fromJson(string DateTime)
====== Arguments ======
DateTime is in string format yyyy-MM-ddThh:mm:ss.msZ
====== Return type ======
[[DateTime_class]]
====== Examples ======
<source lang="javascript">
string dtJson = "2024-12-30T08:22:23.9900000Z";
DateTime dateTime = DateTime_fromJson(dtJson);//2024-12-30 08:22:23
</source>
[[Category:General_Functions]]

DateTime toJson

2025-04-03T09:21:26Z

Nguyenduyan:

==== DateTime_toJson====
Convert [[DateTime_class]] or DateTime array to string
======Syntax======
DateTime_toJson(DateTime[, Type])
====== Arguments ======
DateTime can be [[DateTime_class]] or DateTime array

Type number: 0 for return full DateTime (default), 1 for return DateOnly, 2 for return TimeOnly
====== Return type ======
string of datetime, format yyyy-MM-ddThh:mm:ss.msZ
====== Examples ======
<source lang="javascript">
DateTime dateTime = new DateTime();
//array dateTime = getDateTime();
string dtJson;
dtJson = DateTime_toJson(dateTime);//2024-12-30T08:22:23.9900000Z
dtJson = DateTime_toJson(dateTime, 1);//2024-12-30
dtJson = DateTime_toJson(dateTime, 2);//08:22:23.9900000
</source>
[[Category:General_Functions]]

DateTime fromJson

2025-04-03T09:19:46Z

Nguyenduyan:

==== DateTime_fromJson====
Convert DateTime string Json to [[DateTime_class]]
====Syntax====
DateTime_fromJson(string DateTime)
==== Arguments ====
DateTime is in string format yyyy-MM-ddThh:mm:ss.msZ
==== Return type ====
[[DateTime_class]]
==== Examples ====
<source lang="javascript">
string dtJson = "2024-12-30T08:22:23.9900000Z";
DateTime dateTime = DateTime_fromJson(dtJson);//2024-12-30 08:22:23
</source>
[[Category:General_Functions]]

OidcAuthenticationFlow class

2025-04-03T09:09:40Z

Nguyenduyan:

{{CGscriptClass_Template
|Name=<nowiki>OidcAuthenticationFlow</nowiki>
|Description=<nowiki>Specification of a Authentication Flow oidc client</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete this client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Oidc client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetClientSecret</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>secret</nowiki>|Description=<nowiki>The new secret</nowiki>}}
|Description=<nowiki>Set Oidc client secret</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AppRolesScriptId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set id of the script that determines cg_roles claim to let your app do role based security. This must run with impersonation and be public. 0 to unset</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AskUserForConsent</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set ask user for consent when connecting</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanAuthRespondent</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the respondent can login via redirect from qas</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanKeepSecret</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the application can keep secret (ie. false for an SPA)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClientId</nowiki>|HasGetter=1|Description=<nowiki>Oidc client id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>DisplayNames</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set display names</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsBuiltIn</nowiki>|HasGetter=1|Description=<nowiki>True, if a system client</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Layout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set layout to use for login screen</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>OptionalScopes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set optional scopes</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>OwnerResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set owner resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>PostLogoutRedirectUris</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set post logout redirect URIs</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>RedirectUris</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set redirect URIs accepted to return user to after auth</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>Scopes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set scopes</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=OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_createOrUpdate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Create a new oidc client or update existing based on clientId</nowiki>}}
{{CGscriptMethods_Template|ReturnType=OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_getByClientId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Get a single known client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_getList</nowiki>|Description=<nowiki>Get a list of clients, ordered by clientId</nowiki>}}
}}

File:Oidc authR.jpg

2025-04-03T08:59:27Z

Nguyenduyan:

Make oidc work with respondents auth with guid only

2025-04-03T08:59:12Z

Nguyenduyan: Created page with "File:Oidc_authR.jpg Category:Guides"

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

OidcServer2ServerClient class

2025-04-03T08:44:00Z

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=<nowiki>OidcServer2ServerClient</nowiki> |Description=<nowiki>Specification of a Client Authentication oidc client</nowiki> |InheritsFrom=object|Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete this client</nowiki>}} {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Oidc client</nowiki>}} {{CGscriptMethods_Template|ReturnType=Empty|..."

{{CGscriptClass_Template
|Name=<nowiki>OidcServer2ServerClient</nowiki>
|Description=<nowiki>Specification of a Client Authentication oidc client</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete this client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Oidc client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetClientSecret</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>secret</nowiki>|Description=<nowiki>The new secret</nowiki>}}
|Description=<nowiki>Set Oidc client secret</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>ClientId</nowiki>|HasGetter=1|Description=<nowiki>Oidc client id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>DisplayNames</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set display names</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsBuiltIn</nowiki>|HasGetter=1|Description=<nowiki>True, if a system client</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>OwnerResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set owner resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RunAsUserId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set id of the impersonated user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>Scopes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get scopes</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=OidcServer2ServerClient|Name=<nowiki>OidcServer2ServerClient_createOrUpdate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Create a new oidc client or update existing based on clientId</nowiki>}}
{{CGscriptMethods_Template|ReturnType=OidcServer2ServerClient|Name=<nowiki>OidcServer2ServerClient_getByClientId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Get a single known client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of OidcServer2ServerClient|Name=<nowiki>OidcServer2ServerClient_getList</nowiki>|Description=<nowiki>Get a list of clients, ordered by clientId</nowiki>}}
}}

OidcAuthenticationFlow class

2025-04-03T08:43:22Z

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=<nowiki>OidcAuthenticationFlow</nowiki> |Description=<nowiki>Specification of a Authentication Flow oidc client</nowiki> |InheritsFrom=object|Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete this client</nowiki>}} {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Oidc client</nowiki>}} {{CGscriptMethods_Template|ReturnType=Empty|Nam..."

{{CGscriptClass_Template
|Name=<nowiki>OidcAuthenticationFlow</nowiki>
|Description=<nowiki>Specification of a Authentication Flow oidc client</nowiki>
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Delete this client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Oidc client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetClientSecret</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>secret</nowiki>|Description=<nowiki>The new secret</nowiki>}}
|Description=<nowiki>Set Oidc client secret</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AppRolesScriptId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set id of the script that determines cg_roles claim to let your app do role based security. 0 to unset</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AskUserForConsent</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set ask user for consent when connecting</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanAuthRespondent</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the respondent can login via redirect from qas</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanKeepSecret</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if the application can keep secret (ie. false for an SPA)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClientId</nowiki>|HasGetter=1|Description=<nowiki>Oidc client id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>DisplayNames</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set display names</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsBuiltIn</nowiki>|HasGetter=1|Description=<nowiki>True, if a system client</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Layout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set layout to use for login screen</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>OptionalScopes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set optional scopes</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>OwnerResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set owner resource id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>PostLogoutRedirectUris</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set post logout redirect URIs</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>RedirectUris</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set redirect URIs accepted to return user to after auth</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of strings|Name=<nowiki>Scopes</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set scopes</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=OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_createOrUpdate</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Create a new oidc client or update existing based on clientId</nowiki>}}
{{CGscriptMethods_Template|ReturnType=OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_getByClientId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>clientId</nowiki>|Description=<nowiki>Oidc client id</nowiki>}}
|Description=<nowiki>Get a single known client</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of OidcAuthenticationFlow|Name=<nowiki>OidcAuthenticationFlow_getList</nowiki>|Description=<nowiki>Get a list of clients, ordered by clientId</nowiki>}}
}}

File:2025-01-06 13-54-36.jpg

2025-04-03T08:42:07Z

Nguyenduyan:

QuestionnaireBatchJob class

2025-04-03T08:41:27Z

Nguyenduyan: 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= {..."

{{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>}}
}}
=== '''Examples''' ===
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>

Workflow setGlobal

2025-04-03T08:40:19Z

Nguyenduyan: Created page with "== Workflow_setGlobal== Set values for scripts invoked from WorkflowScript_class ==Syntax== Workflow_setGlobal(string parameterName, AnyType value) == Return type == Empty == Examples == <source lang="javascript"> Workflow_setGlobal("x", 1000); //Get global value on dynamic script string script = " number a = 1; return a + Workflow_getGlobal(\"x\"); "; WorkflowScript wfS = new WorkflowScript (script, false); wfS.Call();//1001 //Get global value on existing wokfl..."

== Workflow_setGlobal==
Set values for scripts invoked from [[WorkflowScript_class]]

==Syntax==
Workflow_setGlobal(string parameterName, AnyType value)
== Return type ==
Empty
== Examples ==

<source lang="javascript">
Workflow_setGlobal("x", 1000);
//Get global value on dynamic script
string script = "
number a = 1;
return a + Workflow_getGlobal(\"x\");
";
WorkflowScript wfS = new WorkflowScript (script, false);
wfS.Call();//1001
//Get global value on existing wokflow
wfS = new WorkflowScript (wf);
wfS.Call();//1002

/*
script on the above wf:
number a = 2;
return a + Workflow_getGlobal("x");
*/
</source>

[[Category:General_Functions]]