Catglobe Wiki - User contributions [en]

SampleRule class

2026-07-24T05:19:52Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>SampleRule</nowiki>
|Description=<nowiki>Represents a SampleRule.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Sample rule resource id</nowiki>}}
|Description=<nowiki>Fetch exist sample rule</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of rule</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Resource id of group to sample</nowiki>}}
|Description=<nowiki>Create new group samplerule</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of rule</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Questionnaire|Name=<nowiki>questionnaire</nowiki>|Description=<nowiki>The questionnaire contains this sample rule</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupId</nowiki>|Description=<nowiki>Resource id of group to sample</nowiki>}}
|Description=<nowiki>Create and add new group sample rule to questionnaire object</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Rebuild</nowiki>|Description=<nowiki>Rebuild sample rule</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the Samplerule</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>Active</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ActualSize</nowiki>|HasGetter=1|Description=<nowiki>Get how many qas is currently sampled for this rule.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DeletedDate</nowiki>|HasGetter=1|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>GroupId</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Get id of group associated with this samplerule.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>GroupResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Resource id of sample rule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Name of Samplerule.</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>QuestionnaireId</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Get id of questionnaire associated with this samplerule.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get resourceId of questionnaire associated with this samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RequestedSize</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get how many qas is requested to sample for this rule.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleType</nowiki>|HasGetter=1|Description=<nowiki>Get the Type of Samplerule.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithData</nowiki>|HasGetter=1|Description=<nowiki>Get how many qas for this rule have data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithoutData</nowiki>|HasGetter=1|Description=<nowiki>Get how many qas for this rule does not have data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}
|Description=<nowiki>Get all sample rules associated with a group</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>SampleRule_getByQuestionnaireResourceId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire to get samples from</nowiki>}}
|Description=<nowiki>Get all sample rules associated with a group</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SampleRule_rebuild</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of SampleRule|Name=<nowiki>samplesRules</nowiki>|Description=<nowiki>Sample rules to rebuild samples for</nowiki>}}
|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
number groupRId = 15644390;
array sampleRule = SampleRule_getByGroupResourceId(groupRId);
for(number i = 0; i<sampleRule.Count; i++)
{
print(sampleRule[i].Active);
print(sampleRule[i].ActualSize);
print(sampleRule[i].DeletedDate);
print(sampleRule[i].Description);
print(sampleRule[i].SampleRuleType );
print(sampleRule[i].SizeWithData );
print(sampleRule[i].SizeWithoutData );
}
</source>
<source lang="javascript">
//add sameple to qnaire and rebuild
Questionnaire qnaire = new Questionnaire (17148177);
number groupSample = 17146562;
SampleRule sampleRule = new SampleRule ("s1", qnaire, groupSample);
sampleRule.Save();
sampleRule.Rebuild();
</source>

Questionnaire class

2026-07-24T05:18:04Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>Questionnaire</nowiki>
|Description=<nowiki>The questionnaire object.</nowiki>
|InheritsFrom=Array|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-guid|Name=<nowiki>guid</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 template'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>|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=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=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=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|HasGetter=1|Description=<nowiki>Average successful interview time</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CatiOutcomeSet</nowiki>|HasGetter=1|Description=<nowiki>Name of the CATI outcome set (contact status type) assigned to this questionnaire</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=string|Name=<nowiki>DefaultLanguage</nowiki>|HasGetter=1|Description=<nowiki>ISO code of the questionnaire's default language</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=bool|Name=<nowiki>DisplayInMyQuestionnaire</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether this questionnaire is shown in respondents' personal questionnaire list</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>Resource 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=Array of strings|Name=<nowiki>Languages</nowiki>|HasGetter=1|Description=<nowiki>ISO codes of all languages this questionnaire is available in</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>ManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Estimated man-hours for this questionnaire</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=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 STATUS_xxx</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>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=bool|Name=<nowiki>TimeRegistration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether time registration is enabled for this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|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 Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Questionnaire|Name=<nowiki>Questionnaire_getByGuid</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string-guid|Name=<nowiki>guid</nowiki>|Description=<nowiki>Guid of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire by guid</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Questionnaire_save</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Questionnaire|Name=<nowiki>questionnaire</nowiki>|Description=<nowiki>The questionnaire object to save</nowiki>}}
|Obsolete=1
|Description=<nowiki>Persists changes to a questionnaire object. Use questionnaire.Save() instead.</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>

User class

2026-07-24T05:15:46Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>User</nowiki>
|Description=<nowiki>A user</nowiki>
|InheritsFrom=Array|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangePassword</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>newPassword</nowiki>|Description=<nowiki>The new password</nowiki>}}
|Description=<nowiki>Change the users password</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DeleteUser</nowiki>|Description=<nowiki>Delete the user</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the user</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=DateTime|Name=<nowiki>AccessExpiration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After this date the user can no longer login</nowiki>}}
{{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=bool|Name=<nowiki>CalculatedManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>True if it Man Hours is calculated. Set to true to recalculate.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>City</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>City of the address</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CountryIsoCode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Iso code of the country of the address</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserId</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Id of the user that created this user.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Resource id of the user that created this user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Date of creation</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CultureIsoCode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Iso code of the culture of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CurrencyIsoName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Iso 4217 name of the currency of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Deleted</nowiki>|HasGetter=1|Description=<nowiki>True if deleted</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DeletedDate</nowiki>|HasGetter=1|Description=<nowiki>Date of deletion</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Disabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>True if user is disabled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DisabledDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Date user was disabled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DiscountName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Current applied discount in webshop</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Email</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Email of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FirstName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Firstname of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LanguageIsoCode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Iso code of the language of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastDateUpdatePassWord</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Date the user last changed their password</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LastName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>LastName of the user</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=string|Name=<nowiki>MiddleName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>MiddleName of the user</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=int|Name=<nowiki>ModifiedByUserId</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Id of the user that modified this user.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Resource id of the user that modified this user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Date of last modification</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>ParentResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource id of the parent</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>PhoneNumbers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set phonenumbers</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PointBalance</nowiki>|HasGetter=1|Description=<nowiki>Currenct number of points available</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Postbox</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Postbox of the address</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PrimaryKey</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Id of the user.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ProtectedUntilDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Prior to this date the user can not be sampled</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Region</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Region of the address</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceGuid</nowiki>|HasGetter=1|Description=<nowiki>Guid of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>Resource id of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceManHours</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Man Hours of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceManHoursAsString</nowiki>|HasGetter=1|Description=<nowiki>Formatted Man Hours as Hours:Min</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Id of the template.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource Id of the template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StreetAddress</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Street of the address</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=bool|Name=<nowiki>TimeRegEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>True if it is possible to register time for this resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimezoneId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Id of the timezone of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TimezoneName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Iana Id of the timezone of the user. Notice not all ids are accepted</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>Username</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Login username of the user</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Website</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Website of the address</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ZipCode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>ZipCode of the address</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>User_expirePoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>userResourceIds</nowiki>|Description=<nowiki>Users to expire points for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Expire points accumulated prior to this date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>}}
|Description=<nowiki>Test expire users points. Return dictionary of userResourceIds and number of points that would be expired</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>User_expirePoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>userResourceIds</nowiki>|Description=<nowiki>Users to expire points for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Expire points accumulated prior to this date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>test</nowiki>|Description=<nowiki>If true only return points that would be expired</nowiki>}}
|Description=<nowiki>Expire users points. Return dictionary of userResourceIds and number of points expired</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>User_formatName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=User|Name=<nowiki>user</nowiki>|Description=<nowiki>User to save</nowiki>}}
|Description=<nowiki>Generate full name of user</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>User_generateRandomNumericPassword</nowiki>|Description=<nowiki>Generate a new password with only digits</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>User_generateRandomNumericPassword</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>length</nowiki>|Description=<nowiki>Length of generated password</nowiki>}}
|Description=<nowiki>Generate a new password with only digits</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>User_generateRandomPassword</nowiki>|Description=<nowiki>Generate a new password</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>User_generateRandomPassword</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>length</nowiki>|Description=<nowiki>Length of generated password</nowiki>}}
|Description=<nowiki>Generate a new password</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getCallingLoggedInUser</nowiki>|Description=<nowiki>Fetch current user filling out QAS on someone elses behalf</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Array|Name=<nowiki>User_getCommunicationHistory</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>}}
|Description=<nowiki>Get history of all attempts to communicate to a user.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getCurrentUser</nowiki>|Description=<nowiki>Fetch current user. This will be impersonated user if set.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getLoggedInUser</nowiki>|Description=<nowiki>Fetch current user before applying impersonation</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_getPointsEarnedInPeriod</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Date to calculate from</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Date to calculate to</nowiki>}}
|Description=<nowiki>Get number of points earned in a period.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_getPointsUsedInPeriod</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Date to calculate from</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Date to calculate to</nowiki>}}
|Description=<nowiki>Get number of points used in a period.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getQasUser</nowiki>|Description=<nowiki>Fetch user of the current QAS. May return Empty.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_getResourceIdFromUserId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>User id</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the resource id of the user with the given legacy user id.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of ints|Name=<nowiki>User_getResourceIdFromUserIds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>ids</nowiki>|Description=<nowiki>User ids</nowiki>}}
|Obsolete=1
|Description=<nowiki>Map legacy user ids to user resource ids.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_getRoleIdByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Resource name of the resource template</nowiki>}}
|Obsolete=1
|Description=<nowiki>Get the resource template id of the resource template with the given name.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_getRoleResourceIdByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Resource name of the resource template</nowiki>}}
|Description=<nowiki>Get the resource template id of the resource template with the given name.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Array|Name=<nowiki>User_getTransactionHistory</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>}}
|Description=<nowiki>Get history of all transactions for a user.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of Array|Name=<nowiki>User_getTransactionHistory</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Date to calculate from</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Date to calculate to</nowiki>}}
|Description=<nowiki>Get history of all transactions for a user in period.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getUserByGuid</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>guid</nowiki>|Description=<nowiki>Guid of user</nowiki>}}
|Description=<nowiki>Fetch existing user. Returns Empty if user doesnt exist</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getUserByResourceId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>Resource id of user</nowiki>}}
|Description=<nowiki>Fetch existing user. Returns Empty if user doesnt exist</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_getUserByUsername</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>username</nowiki>|Description=<nowiki>Username of user</nowiki>}}
|Description=<nowiki>Fetch existing user. Returns Empty if user doesnt exist</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of User|Name=<nowiki>User_getUsersByEmail</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>email</nowiki>|Description=<nowiki>Email to search for</nowiki>}}
|Description=<nowiki>Fetch existing users. Returns Empty if user doesnt exist</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of User|Name=<nowiki>User_getUsersByEmail</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateResourceId</nowiki>|Description=<nowiki>Limit users to this resource template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>email</nowiki>|Description=<nowiki>Email to search for</nowiki>}}
|Description=<nowiki>Fetch existing users. Returns Empty if user doesnt exist</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of User|Name=<nowiki>User_getUsersByGroupResourceId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Resource id of group</nowiki>}}
|Description=<nowiki>Fetch existing users.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of User|Name=<nowiki>User_getUsersByResourceIds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>resourceIds</nowiki>|Description=<nowiki>Resource ids of users</nowiki>}}
|Description=<nowiki>Fetch existing users.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>User_insertPoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to add</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>}}
|Description=<nowiki>Add points to user of current QAS.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>User_insertPoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to add</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of user that gets the points</nowiki>}}
|Description=<nowiki>Add custom points to user.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>User_isMemberOfSampleRule</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userId</nowiki>|Description=<nowiki>id of user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>sampleRuleId</nowiki>|Description=<nowiki>id of sample rule</nowiki>}}
|Description=<nowiki>Returns whether a user is member of specified sample.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>User_isValidUsername</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>username</nowiki>|Description=<nowiki>Username of user</nowiki>}}
|Description=<nowiki>Return true if username is valid.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_new</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceTemplateId</nowiki>|Description=<nowiki>Resource Id of the template</nowiki>}}
|Description=<nowiki>Create a new user instance</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_new</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceTemplateId</nowiki>|Description=<nowiki>Resource Id of the template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>mask</nowiki>|Description=<nowiki>Mask to use to generate username</nowiki>}}
|Description=<nowiki>Create a new user instance</nowiki>}}
{{CGscriptMethods_Template|ReturnType=User|Name=<nowiki>User_new</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>username</nowiki>|Description=<nowiki>Username of new user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>password</nowiki>|Description=<nowiki>Password of new user</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceTemplateId</nowiki>|Description=<nowiki>Resource Id of the template</nowiki>}}
|Description=<nowiki>Create a new user instance</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>User_save</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=User|Name=<nowiki>user</nowiki>|Description=<nowiki>User to save</nowiki>}}
|Obsolete=1
|Description=<nowiki>Save the user</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>User_usernameExists</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>username</nowiki>|Description=<nowiki>Username of user</nowiki>}}
|Description=<nowiki>Check if a username already exists.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>}}
|Description=<nowiki>Remove points from user of current QAS. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of user that gets the points</nowiki>}}
|Description=<nowiki>Remove custom points from user. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of user that gets the points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>customType</nowiki>|Description=<nowiki>Store custom transaction type. Can be 1-127, or 0 for ManualTransaction</nowiki>}}
|Description=<nowiki>Remove custom points from user. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
}}

QuestionnaireTemplate class

2026-07-24T05:13:55Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireTemplate</nowiki>
|Description=<nowiki>Template for a questionnaire.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire template</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template - it is highly recommended to use QuestionnaireTemplate_getCached if just reading</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Qualified name of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template 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>resourceTemplateId</nowiki>|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}
|Description=<nowiki>Create new questionnaire template</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>GetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>}}
|Description=<nowiki>Get value of property type, return empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionTemplate|Name=<nowiki>GetQuestion</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>label</nowiki>|Description=<nowiki>Question label</nowiki>}}
|Description=<nowiki>Return a question by label or empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>increaseStructureVersion</nowiki>|Description=<nowiki>Increase structure version will force reset all QAS sequence. Be careful when setting this to false.</nowiki>}}
|Description=<nowiki>Save questionnaire template</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>String or LocalizedString depend on property type. If value is empty then the property will be removed</nowiki>}}
|Description=<nowiki>Set value for property type</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>DefaultLanguage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Gets and sets the default language of this questionnaire. Its value is language iso code</nowiki>}}
{{CGscriptProperties_Template|ReturnType=QuestionGroupRoot|Name=<nowiki>Groups</nowiki>|HasGetter=1|Description=<nowiki>Information about question groups in questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasData</nowiki>|HasGetter=1|Description=<nowiki>check if this questionnaire template contains data or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Resource id of questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Languages</nowiki>|HasGetter=1|Description=<nowiki>Active languages associated with this questionnaire. Its value is language iso code</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire template 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>ParentId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Parent resource's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of QuestionnaireProperty|Name=<nowiki>Properties</nowiki>|HasGetter=1|Description=<nowiki>Get configuration properties of this questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QualifiedName</nowiki>|HasGetter=1|Description=<nowiki>Get qualified name of questionnaire name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of QuestionTemplate|Name=<nowiki>Questions</nowiki>|HasGetter=1|Description=<nowiki>Get configuration questions of this questionnaire template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource tempalte's id of questionnaire template. Set it's 0 to use default resource template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>StructureVersion</nowiki>|HasGetter=1|Description=<nowiki>Structure version of the questionnaire template. It is increased when updating</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>Version</nowiki>|HasGetter=1|Description=<nowiki>Version of the questionnaire template. It is increased when updating</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=QuestionnaireTemplate|Name=<nowiki>QuestionnaireTemplate_current</nowiki>|Description=<nowiki>Get questionnaire template in current QAS or Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>QuestionnaireTemplate_getActiveLanguages</nowiki>|Description=<nowiki>Return a Dictionary of all languages supported in system. The dictionary item has key is iso code and value is object {isocode: string, name: string, viewerSupported: bool}</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionnaireTemplate|Name=<nowiki>QuestionnaireTemplate_getCached</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire template</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template using a cached version. Do not use when editing</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionnaireTemplate|Name=<nowiki>QuestionnaireTemplate_getCachedFromQuestionnaireId</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire template</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire template using a cached version using the questionnaire id. Do not use when editing</nowiki>}}
}}
=== '''Examples''' ===
<source lang="javascript">
// new QuestionnaireTemplate
string qnaireTemplateName = "test";
number parentId = 17148135;
number resourceTemplateId = 17148218;// 0 to use the default
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaireTemplateName, parentId, resourceTemplateId);
bool increaseStructureVersion = false;//Increase structure version will force reset all QAS sequence
qt.Save(increaseStructureVersion);
//Catglobe.Json.Encode(qt);
</source>
<source lang="javascript">
//set, get a qnaire property
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
print(qt.Languages);//{en-GB,da-DK}
LocalizedString a = new LocalizedString ({"": "Completed", "da-DK": "Komplet"}, "en-GB");
qt.SetProperty(Question_Property_QuestionnaireCompletedText, a);
qt.Save(false);
print(qt.GetProperty(Question_Property_QuestionnaireCompletedText).ToDictionary());//{"": Completed, "da-DK": Komplet}
</source>
<source lang="javascript">
//Remore an existing qnaire property
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
qt.SetProperty(Question_Property_QuestionnaireCompletedText, empty);
qt.Save(false);
print(qt.GetProperty(Question_Property_QuestionnaireCompletedText));//empty
</source>
<source lang="javascript">
//get all existing qnaire properties
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
print(qt.Properties);//{QuestionnaireProperty,...}
for(i for 0; qt.Properties.Count){
QuestionnaireProperty p = qt.Properties[i];
if(p.IsLocalize)
print(p.PropertyTypeAsString +": "+ convertToString(p.Value.ToDictionary()));
else print (p.PropertyTypeAsString +": "+ p.Value);
}
</source>
<source lang="javascript">
//get an existing question
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q1");//return QuestionTemplate or empty if not found
</source>
<source lang="javascript">
//get all existing questions
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
print(qt.Questions);//{QuestionTemplate,...}
for(i for 0; qt.Questions.Count){
QuestionTemplate q = qt.Questions[i];
print(q.Label);
}
</source>
<source lang="javascript">
//Delete a question
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
number index;
for(i for 0; qt.Questions.Count){
if(qt.Questions[i].Label == "Q1" && !qt.Questions[i].HasData)
index = i;
}
if(index!=empty)
qt.Questions.Remove(qt.Questions[index]);
qt.Save(true);
</source>
<source lang="javascript">
//get question group
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
qt.Groups;//QuestionGroupRoot
</source>

ResourceProperty class

2026-07-24T04:43:14Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>ResourceProperty</nowiki>
|Description=<nowiki>Represents a resource property constant with its current value.</nowiki>
|InheritsFrom=Array|Methods=
{{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=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|Description=<nowiki>Display label of the constant option</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>OptionId</nowiki>|HasGetter=1|Description=<nowiki>Primary key of the constant option</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>Type</nowiki>|HasGetter=1|Description=<nowiki>Constant-option type (see RESOURCE_PROPERTY_TYPE constants)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=object|Name=<nowiki>Value</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Current value of the constant</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ResourceProperty_getResourcesProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>}}
|Description=<nowiki>Returns the resource properties of multiple resources.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ResourceProperty_getResourcesProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>resource unique ids</nowiki>|Description=<nowiki>Array of resource unique ids</nowiki>}}
|Description=<nowiki>Returns the resource properties of multiple resources.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ResourceProperty_saveResourceProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>propertyArray</nowiki>|Description=<nowiki>Array of resource property objects</nowiki>}}
|Description=<nowiki>Saves resource properties for the specified resource.</nowiki>}}
}}

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

<source lang="javascript">
number qnaire;
array a = ResourceProperty_getResourcesProperties(qnaire);
array p;
for(i for 0; a.Count){
ResourceProperty r = a[i];
if(r.Type == RESOURCE_PROPERTY_TYPE_NUMBER && r.Name == "PanelType") {
r.Value=1;
p.Add(r);
}
}
ResourceProperty_saveResourceProperties(qnaire, p);
</source>

ResourceProperty class

2026-07-24T04:39:07Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>ResourceProperty</nowiki>
|Description=<nowiki>Represents a resource property constant with its current value.</nowiki>
|InheritsFrom=Array|Methods=
{{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=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|Description=<nowiki>Display label of the constant option</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>OptionId</nowiki>|HasGetter=1|Description=<nowiki>Primary key of the constant option</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>Type</nowiki>|HasGetter=1|Description=<nowiki>Constant-option type (see RESOURCE_PROPERTY_TYPE constants)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=object|Name=<nowiki>Value</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Current value of the constant</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ResourceProperty_getResourcesProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>}}
|Description=<nowiki>Returns the resource properties of multiple resources.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ResourceProperty_getResourcesProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>resource unique ids</nowiki>|Description=<nowiki>Array of resource unique ids</nowiki>}}
|Description=<nowiki>Returns the resource properties of multiple resources.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ResourceProperty_saveResourceProperties</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>propertyArray</nowiki>|Description=<nowiki>Array of resource property objects</nowiki>}}
|Description=<nowiki>Saves resource properties for the specified resource.</nowiki>}}
}}

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

<source lang="javascript">
number qnaire;
array a = ResourceProperty_getResourcesProperties(qnaire);
array p;
for(i for 0; a.Count){
ResourceProperty r = a[i];
if(r.Name == "PanelType") {
r.Value=2;
p.Add(r);
}
}
ResourceProperty_saveResourceProperties(qnaire, p);
</source>

Resource class

2026-07-24T04:14:24Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>Resource</nowiki>
|Description=<nowiki>Represents a resource.</nowiki>
|InheritsFrom=Array|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Deletes this resource</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=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|Description=<nowiki>Name of the resource</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>ParentResourceId</nowiki>|HasGetter=1|Description=<nowiki>Unique id of the parent resource</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>Resource unique id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceType</nowiki>|HasGetter=1|Description=<nowiki>Resource type constant</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>TemplateResourceId</nowiki>|HasGetter=1|Description=<nowiki>Unique id of the resource template (0 if none)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Resource_delete</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>}}
|Description=<nowiki>Deletes a resource</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Resource|Name=<nowiki>Resource_getParentResource</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resource unique id</nowiki>|Description=<nowiki>Resource unique id</nowiki>}}
|Description=<nowiki>Gets the parent resource of a resource</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>Resource_searchByChildResourceIdAndResourceType</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>resource id</nowiki>|Description=<nowiki>Array of child resource IDs to search parents for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Resource type</nowiki>|Description=<nowiki>Resource type to filter parent resources by</nowiki>}}
|Description=<nowiki>Returns a dictionary mapping parent resource IDs to arrays of child resources, filtered by the given resource type</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Resource_searchByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>searchName</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>Resource type constant to filter by</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateResourceId</nowiki>|Description=<nowiki>Resource template id (0 for any)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nameSearchType</nowiki>|Description=<nowiki>Name search type constant (contains, starts-with, etc.)</nowiki>}}
|Description=<nowiki>Searches for resources matching a name pattern, filtered by type, template and search type</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Resource_searchByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>searchName</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>Resource type constant to filter by</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateResourceId</nowiki>|Description=<nowiki>Resource template id (0 for any)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nameSearchType</nowiki>|Description=<nowiki>Name search type constant (contains, starts-with, etc.)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>maxCount</nowiki>|Description=<nowiki>Maximum number of results to return</nowiki>}}
|Description=<nowiki>Searches for resources matching a name pattern, filtered by type, template and search type, with max count</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Resource_searchByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>searchName</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>Resource type constant to filter by</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateResourceId</nowiki>|Description=<nowiki>Resource template id (0 for any)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nameSearchType</nowiki>|Description=<nowiki>Name search type constant (contains, starts-with, etc.)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>maxCount</nowiki>|Description=<nowiki>Maximum number of results to return</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource id to restrict search under (0 for all)</nowiki>}}
|Description=<nowiki>Searches for resources matching a name pattern, filtered by type, template, search type and parent resource</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Resource_searchByName</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>searchName</nowiki>|Description=<nowiki>Name pattern to search for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceType</nowiki>|Description=<nowiki>Resource type constant to filter by</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateResourceId</nowiki>|Description=<nowiki>Resource template id (0 for any)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>nameSearchType</nowiki>|Description=<nowiki>Name search type constant (contains, starts-with, etc.)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>maxCount</nowiki>|Description=<nowiki>Maximum number of results to return</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource id to restrict search under (0 for all)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool?|Name=<nowiki>includeSubChildren</nowiki>|Description=<nowiki>Whether to include all descendants rather than direct children only</nowiki>}}
|Description=<nowiki>Searches for resources matching a name pattern, filtered by type, template, search type, parent resource and sub-children</nowiki>}}
}}

ResourceProperty class

2026-07-24T04:01:49Z

Antester@voxmeter.dk1:

DateTime class

2026-07-24T03:52:58Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>DateTime</nowiki>
|Description=<nowiki>The object behind the first class construct: `DateTime d = #2024-01-01#;`.</nowiki>
|InheritsFrom=Array|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Now in UTC timezone</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to parse as a date, syntax is same as for constant values</nowiki>}}
|Description=<nowiki>New based on a string representation of a date</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to parse as a date</nowiki>}}
|Description=<nowiki>New based on a array representation of a date</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to parse as a date</nowiki>}}
|Description=<nowiki>New based on a array representation of a date</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>}}
|Description=<nowiki>New based on year, month and day (current user's timezone)</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Timezone ID</nowiki>}}
|Description=<nowiki>New based on year, month, day and timezone</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>Hour</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>Minute</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>Second</nowiki>}}
|Description=<nowiki>New based on year, month, day, hour, minute and second (current user's timezone)</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>Hour</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>Minute</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>Second</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Timezone ID</nowiki>}}
|Description=<nowiki>New based on year, month, day, hour, minute, second and timezone</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>AsUnixtimeMillisecondsSince1970</nowiki>|Description=<nowiki>Return value as number of milliseconds since 1 / 1 1970</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>AsUnixtimeSecondsSince1970</nowiki>|Description=<nowiki>Return value as number of seconds since 1/1 1970</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>CompareTo</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to compare to</nowiki>}}
|Description=<nowiki>Compare to object. See ArrayConstant.OrderBy</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addDays</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of days to add</nowiki>}}
|Description=<nowiki>Add days to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addHours</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of hours to add</nowiki>}}
|Description=<nowiki>Add hours to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addMinutes</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of minutes to add</nowiki>}}
|Description=<nowiki>Add minutes to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addMonths</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of months to add</nowiki>}}
|Description=<nowiki>Add months to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addSeconds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of seconds to add</nowiki>}}
|Description=<nowiki>Add seconds to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>addYears</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of years to add</nowiki>}}
|Description=<nowiki>Add years to this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>daysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Description=<nowiki>Returns the number of whole days between this and another DateTime</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=number|Name=<nowiki>secondsBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Description=<nowiki>Returns the total number of seconds between this and another DateTime</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>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractDays</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of days to subtract</nowiki>}}
|Description=<nowiki>Subtract days from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractHours</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of hours to subtract</nowiki>}}
|Description=<nowiki>Subtract hours from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractMinutes</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of minutes to subtract</nowiki>}}
|Description=<nowiki>Subtract minutes from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractMonths</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of months to subtract</nowiki>}}
|Description=<nowiki>Subtract months from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractSeconds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of seconds to subtract</nowiki>}}
|Description=<nowiki>Subtract seconds from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>subtractYears</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Amount</nowiki>|Description=<nowiki>Number of years to subtract</nowiki>}}
|Description=<nowiki>Subtract years from this DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>toInvariant</nowiki>|Description=<nowiki>Converts this DateTime to an invariant-format string (yyyy-MM-dd HH:mm:ss)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>toJson</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Type</nowiki>|Description=<nowiki>Output format: 0=DateTime (default), 1=DateOnly, 2=TimeOnly</nowiki>}}
|Description=<nowiki>Serialises to a JSON ISO 8601 string (0=DateTime, 1=DateOnly, 2=TimeOnly)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Description=<nowiki>Returns the number of working days between this and another DateTime</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>Holidays</nowiki>|Description=<nowiki>List of holiday DateTime objects</nowiki>}}
|Description=<nowiki>Returns the number of working days (excluding holidays) between this and another DateTime</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>AsArray</nowiki>|HasGetter=1|Obsolete=1
|Description=<nowiki>Return value as the array representation of a date</nowiki>}}
{{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>Day</nowiki>|HasGetter=1|Description=<nowiki>The day-of-month component (1–31)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Hour</nowiki>|HasGetter=1|Description=<nowiki>The hour component (0–23)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>IsoWeek</nowiki>|HasGetter=1|Description=<nowiki>The ISO 8601 week number (1–53)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>IsoWeekYear</nowiki>|HasGetter=1|Description=<nowiki>The ISO 8601 week-year (may differ from Year for dates near year boundaries)</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=int|Name=<nowiki>Millisecond</nowiki>|HasGetter=1|Description=<nowiki>The millisecond component (0–999)</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=int|Name=<nowiki>Minute</nowiki>|HasGetter=1|Description=<nowiki>The minute component (0–59)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Month</nowiki>|HasGetter=1|Description=<nowiki>The month component (1–12)</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>Second</nowiki>|HasGetter=1|Description=<nowiki>The second component (0–59)</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=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Year</nowiki>|HasGetter=1|Description=<nowiki>The year component</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>dayOfWeek</nowiki>|HasGetter=1|Description=<nowiki>Return day of week (0=Sunday, 1=Monday, ..., 6=Saturday)</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addDays</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>The number of days to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add days to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addHours</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>The number of hours to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add hours to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addMinutes</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>The number of minutes to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add minutes to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addMonths</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>The number of months to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add months to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addSeconds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>The number of seconds to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add seconds to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_addYears</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The number of years to add</nowiki>}}
|Obsolete=1
|Description=<nowiki>Add years to a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_compare</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Be compared DateTime</nowiki>|Description=<nowiki>The DateTime to compare</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>To compare DateTime</nowiki>|Description=<nowiki>The DateTime to compare against</nowiki>}}
|Obsolete=1
|Description=<nowiki>Compare two DateTime objects. Returns -1 (less), 0 (equal), or 1 (greater)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_dayOfWeek</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>}}
|Obsolete=1
|Description=<nowiki>Return day of week for a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_daysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of whole days between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_daysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Unused</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of whole days between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_fromInvariant</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime string</nowiki>|Description=<nowiki>The invariant datetime string to parse</nowiki>}}
|Description=<nowiki>Parses an invariant datetime string to a DateTime object, or Empty when the input is absent</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_fromInvariant</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime string</nowiki>|Description=<nowiki>The invariant datetime string to parse; pass empty together with the second argument to get min/max date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool?|Name=<nowiki>if true and empty return maxdate or mindate</nowiki>|Description=<nowiki>When the string is empty: true returns MaxValue, false returns MinValue</nowiki>}}
|Description=<nowiki>Parses an invariant datetime string to a DateTime object (in the current user's timezone), or Empty when both inputs are absent</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_fromJson</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime string</nowiki>|Description=<nowiki>The JSON datetime string to parse</nowiki>}}
|Description=<nowiki>Deserialises a JSON datetime string to a DateTime array, or Empty when the input is absent</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_fromJson</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime string</nowiki>|Description=<nowiki>The JSON datetime string to parse; pass empty together with the second argument to get min/max date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool?|Name=<nowiki>if true and empty return maxdate or mindate</nowiki>|Description=<nowiki>When the string is empty: true returns MaxValue, false returns MinValue</nowiki>}}
|Description=<nowiki>Deserialises a JSON datetime string to a DateTime array, or Empty when both inputs are absent</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getByYMD</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a DateTime array object from year, month and day</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getByYMD</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Timezone ID</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a DateTime array object from year, month, day and timezone</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getByYMD</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>Hour</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>Minute</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>Second</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a DateTime array object from year, month, day, hour, minute and second</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getByYMD</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>Month</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>Day</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>Hour</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>Minute</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>Second</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Timezone ID</nowiki>}}
|Obsolete=1
|Description=<nowiki>Creates a DateTime array object from year, month, day, hour, minute, second and timezone</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getLastDateOfMonth</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The year (e.g. 2024)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>The month number (1-12)</nowiki>}}
|Description=<nowiki>Get the last date of the specified month</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getWeekEnd</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The year (e.g. 2024)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Week</nowiki>|Description=<nowiki>The week number (1-53)</nowiki>}}
|Description=<nowiki>Get the end day of the specified week and year</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_getWeekStart</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The year (e.g. 2024)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Week</nowiki>|Description=<nowiki>The week number (1-53)</nowiki>}}
|Description=<nowiki>Get the start day of the specified week and year</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>DateTime_isLeapYear</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The year (e.g. 2024)</nowiki>}}
|Description=<nowiki>Determine whether the specified year is a leap year</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>DateTime_objToInvariant</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to convert; pass empty to get an Empty result</nowiki>}}
|Obsolete=1
|Description=<nowiki>Converts a DateTime object to an invariant-format string, or Empty if the input is empty</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_parse</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime string</nowiki>|Description=<nowiki>The string to parse as a DateTime</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>DateTime format string</nowiki>|Description=<nowiki>The format string</nowiki>}}
|Description=<nowiki>Parse a DateTime string to a DateTime object with the specified format</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>DateTime_secondsBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the total number of seconds between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>DateTime_secondsBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Unused</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the total number of seconds between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractDays</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Day</nowiki>|Description=<nowiki>The number of days to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract days from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractHours</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Hour</nowiki>|Description=<nowiki>The number of hours to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract hours from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractMinutes</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Minute</nowiki>|Description=<nowiki>The number of minutes to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract minutes from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractMonths</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Month</nowiki>|Description=<nowiki>The number of months to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract months from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractSeconds</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Second</nowiki>|Description=<nowiki>The number of seconds to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract seconds from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>DateTime_subtractYears</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to operate on</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Year</nowiki>|Description=<nowiki>The number of years to subtract</nowiki>}}
|Obsolete=1
|Description=<nowiki>Subtract years from a DateTime object</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>DateTime_toInvariant</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to convert; pass empty to get an Empty result</nowiki>}}
|Obsolete=1
|Description=<nowiki>Converts a DateTime array object to an invariant-format string, or Empty if the input is empty</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>DateTime_toJson</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to serialise; pass empty to get an Empty result</nowiki>}}
|Obsolete=1
|Description=<nowiki>Serialises a DateTime to a JSON ISO 8601 string</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>DateTime_toJson</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>DateTime</nowiki>|Description=<nowiki>The DateTime object to serialise; pass empty to get an Empty result</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Type</nowiki>|Description=<nowiki>Output format: 0 = DateTime (default), 1 = DateOnly, 2 = TimeOnly</nowiki>}}
|Obsolete=1
|Description=<nowiki>Serialises a DateTime to a JSON ISO 8601 string (0=DateTime, 1=DateOnly, 2=TimeOnly)</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of working days (excluding weekends) between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>Holiday</nowiki>|Description=<nowiki>List of holiday DateTime objects</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of working days (excluding weekends and specified holidays) between two DateTime objects</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Unused</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of working days (excluding weekends) between two DateTime objects with optional timezone override</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>DateTime_workDaysBetween</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>First DateTime</nowiki>|Description=<nowiki>The first DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>Second DateTime</nowiki>|Description=<nowiki>The second DateTime object</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>Holiday</nowiki>|Description=<nowiki>List of holiday DateTime objects</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int?|Name=<nowiki>Timezone</nowiki>|Description=<nowiki>Unused</nowiki>}}
|Obsolete=1
|Description=<nowiki>Returns the number of working days (excluding weekends and specified holidays) between two DateTime objects with optional timezone override</nowiki>}}
}}

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

<source lang="javascript">
//*Ex1
DateTime dt = new DateTime ();
print(dt.AsArray);//{2017,10,2,4,13,34,583,40,0}
//*Ex2
DateTime dt = new DateTime("2009/4/5");
print(dt.ToString());//2009-04-05 00:00:00
print(dt.AsArray);//{2009,4,5,0,0,0,0,14,0}
//*Ex3
DateTime dt = new DateTime({2017,10,2,4,13,34,583,40,0});
print(dt.ToString());//2017-10-02 04:13:34
print(dt.AsUnixtimeMillisecondsSince1970());//1506917614583
print(dt.AsUnixtimeSecondsSince1970());//1506917614

</source>

QuestionTemplate class

2026-07-24T03:34:20Z

Antester@voxmeter.dk1:

{{CGscriptClass_Template
|Name=<nowiki>QuestionTemplate</nowiki>
|Description=<nowiki>A question in a questionnaire template</nowiki>
|InheritsFrom=Array|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Question id</nowiki>}}
|Description=<nowiki>Fetch exists question</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>label</nowiki>|Description=<nowiki>Question label</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=QuestionType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Question type, use constant Question_Type_xxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=QuestionnaireTemplate|Name=<nowiki>qt</nowiki>|Description=<nowiki>Questionnaire template</nowiki>}}
|Description=<nowiki>Create new question and add it to questionnaire template</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>GetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>}}
|Description=<nowiki>Get value of property type, return empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>GetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>gridNumber</nowiki>|Description=<nowiki>Index of sub question that the property belong to</nowiki>}}
|Description=<nowiki>Get value of property type, return empty if not found</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>String or LocalizedString depend on property type. If value is empty then the property will be removed</nowiki>}}
|Description=<nowiki>Set value for property type</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetProperty</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=PropertyType constant|Name=<nowiki>type</nowiki>|Description=<nowiki>Use constant Question_Property_xxxx</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>gridNumber</nowiki>|Description=<nowiki>Index of sub question that the property belong to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>String or LocalizedString depend on property type. If value is empty then the property will be removed</nowiki>}}
|Description=<nowiki>Set value for property type</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=Array of AnswerOption|Name=<nowiki>AnswerOptions</nowiki>|HasGetter=1|Description=<nowiki>Get configuration answer options of this question template. Item type is AnswerOption</nowiki>}}
{{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=Array of QuestionCondition|Name=<nowiki>Conditions</nowiki>|HasGetter=1|Description=<nowiki>Get configuration conditional of this question template. Item type is QuestionCondition</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasData</nowiki>|HasGetter=1|Description=<nowiki>Check if this question contains data or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Question id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Label</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Question label</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>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of QuestionProperty|Name=<nowiki>Properties</nowiki>|HasGetter=1|Description=<nowiki>Get configuration properties of this question template. Item type is QuestionProperty</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of SubQuestion|Name=<nowiki>SubQuestions</nowiki>|HasGetter=1|Description=<nowiki>Get configuration sub questions options of this question template. Item type is SubQuestion</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=LocalizedString|Name=<nowiki>Text</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Question text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=QuestionType constant|Name=<nowiki>Type</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Question type, use constant Question_Type_xxx</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=QuestionTemplate|Name=<nowiki>QuestionTemplate_getQuestion</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>Question label</nowiki>|Description=<nowiki>Label of the question</nowiki>}}
|Description=<nowiki>Returns the question object for the given label</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionTemplate|Name=<nowiki>QuestionTemplate_getQuestionByIndex</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Question index</nowiki>|Description=<nowiki>Index of the question</nowiki>}}
|Description=<nowiki>Returns the question at the given index in the current Questionnaire context</nowiki>}}
{{CGscriptMethods_Template|ReturnType=QuestionTemplate|Name=<nowiki>QuestionTemplate_getQuestionByIndex</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>Question index</nowiki>|Description=<nowiki>Index of the question</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>Questionnaire resource id</nowiki>|Description=<nowiki>The Questionnaire resource id. Use 0 for context</nowiki>}}
|Description=<nowiki>Returns the question at the given index for the specified Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionTemplate_getQuestions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>The Questionnaire resource id. Use 0 for context</nowiki>}}
|Description=<nowiki>Returns question objects for all questions in a Questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>QuestionTemplate_getQuestions</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireId</nowiki>|Description=<nowiki>The Questionnaire resource id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionLabels</nowiki>|Description=<nowiki>Array of question labels to return</nowiki>}}
|Description=<nowiki>Returns question objects for the specified labels in a Questionnaire</nowiki>}}
}}

=== '''Examples''' ===
<source lang="javascript">
// create a new question (Open type)
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = new QuestionTemplate ("Q1", Question_Type_Open, qt);
q.Text = new LocalizedString ({"": "Q1 text"}, "");
new AnswerOption (q).Text.SetTranslation ("", "Don't know");
qt.Save(true);
</source>
<source lang="javascript">
// create a new question (singleGrid type)
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = new QuestionTemplate ("Q2", Question_Type_SingleGrid, qt);
q.Text = new LocalizedString ({"": "Q2 text"}, "");
new AnswerOption (q).Text.SetTranslation ("", "Option 1");
new AnswerOption (q).Text.SetTranslation ("", "Option 2");
new SubQuestion (q).Text.SetTranslation ("", "Sub question 1");
new SubQuestion (q).Text.SetTranslation ("", "Sub question 2");
qt.Save(true);
</source>
<source lang="javascript">
//create a new question (scaleGrid type)
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = new QuestionTemplate ("Q3", Question_Type_ScaleGrid, qt);
q.Text = new LocalizedString ({"": "Q3 text"}, "");
new SubQuestion (q).Text.SetTranslation ("", "Sub question 1");
new SubQuestion (q).Text.SetTranslation ("", "Sub question 2");
for(i for 0; q.SubQuestions.Count){
new QuestionProperty (Question_Property_Minimum, i, q).Value = "1";
new QuestionProperty (Question_Property_Maximum, i, q).Value = "5";
new QuestionProperty (Question_Property_MinimumText, i, q).Value.SetTranslation("", "Min text");
new QuestionProperty (Question_Property_MaximumText, i, q).Value.SetTranslation("", "Max text");
}
qt.Save(true);
</source>
<source lang="javascript">
//Get all existing properties of a quesion
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q1");
print(q.Properties);//{QuestionProperty,....}
for(i for 0; q.Properties.Count){
QuestionProperty p = q.Properties[i];
if(p.IsLocalize)
print(p.PropertyTypeAsString +": "+ convertToString(p.Value.ToDictionary()));
else print (p.PropertyTypeAsString +": "+ p.Value);
}
</source>
<source lang="javascript">
// set, get property of a question
Questionnaire qnaire = new Questionnaire (17148177);//unittest: 17148147 tự test: 17148177
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q1");
q.SetProperty (Question_Property_EndPoints, "60");
qt.Save(false);
print(q.GetProperty (Question_Property_EndPoints));//60
</source>
<source lang="javascript">
//get all condition of a question
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q1");
print(q.Conditions);//{QuestionCondition,...}
for(i for 0; q.Conditions.Count){
QuestionCondition c = q.Conditions[i];
print(c.ConditionTypeAsString +" "+ c.Label +" "+c.Expression);
}
</source>
<source lang="javascript">
//get answerOption of a question
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q1");
print(q.AnswerOptions);//{AnswerOption,...}
for(i for 0; q.AnswerOptions.Count){
AnswerOption ao = q.AnswerOptions[i];
print(ao.Value);
}
</source>
<source lang="javascript">
//get subQuesion of a grid question
Questionnaire qnaire = new Questionnaire (17148177);
QuestionnaireTemplate qt = new QuestionnaireTemplate (qnaire.TemplateId);
QuestionTemplate q = qt.GetQuestion("Q2");
print(q.SubQuestions);//{SubQuestion,...}
for(i for 0; q.SubQuestions.Count){
SubQuestion sq = q.SubQuestions[i];
print(sq.Text.ToDictionary());
}
</source>

Field: Qualification level

2026-07-24T03:03:06Z

Antester@voxmeter.dk1:

{{Help_Files_Import_module}}

== Field: Qualification level ==

{| width="1189" class="tableintopic FCK__ShowTableBorders" style="border-collapse: collapse;" border="0" cellspacing="0" cellpadding="2"
|- align="left" valign="top"
| width="1189" style="border: 1px solid rgb(1, 1, 1);" colspan="2" |
== Field: Qualification level ==

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Type

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
Number

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
General Description

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
This is the skill level the user has for a specific qualification

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Import Group

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
Import Qualification Information

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Business Rules

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*Qualification level is only one part of importing qualification. It must go along with qualification to actually succeed.
*Value in this field must match the range [minimum value, maximum value] of the qualification (all qualifications in Catglobe have a user defined minimum and maximum value – please refer to information on how to manage qualifications to know more).
*To update this field for existing users, you must select a User_Id column in step 1 of the import wizard and the value of this column will be used to determine which user’s record to update.
* Value -1 for clear Qualification level on user

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Validation

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*If value is not a number, then invalid value error message will be shown. Error type: ERROR (the import job will not be allowed to be executed).
*If value is not in the range of [min,max] of the qualification name, then an out of range error message will be shown. Error type: ERROR (the import job will not be allowed to be executed).
*If a qualification level is specified in import for a row, but no qualification, then the message ‘Qualification does not exist’ will be shown in step 5 to let user know that data is not clean. Error type: ERROR (the import job will not be allowed to be executed).

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Notes

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*Please refer to help file on [[Qualifications]] to understand all parts of importing qualifications.

|}

[[Category:Import_module]]

Qualification removeLevelOnUsers

2026-07-24T03:00:40Z

Antester@voxmeter.dk1:

{{HelpFiles}}

==== Qualification_removeLevelOnUsers ====
Remove qualification level on users

'''Syntax'''

Qualification_removeLevelOnUsers(array userRId, number qualificationId);

'''Return type'''

Empty

=== Examples ===
<source lang="javascript">
string qualificationName;
array userRId;
Qualification q = Qualification_getByName(qualificationName);
Qualification_removeLevelOnUsers(userRId, q.Id);
</source>
=== Note ===
-1 for clear on Import [[Field:_Qualification_level]]

More info about [[Qualifications]]

File:Qualification.jpg

2026-07-24T02:50:29Z

Antester@voxmeter.dk1:

File:QualificationLevel.jpg

2026-07-24T02:46:11Z

Antester@voxmeter.dk1:

Field: Qualification level

2026-07-24T02:42:58Z

Antester@voxmeter.dk1:

{{Help_Files_Import_module}}

== Field: Qualification level ==

{| width="1189" class="tableintopic FCK__ShowTableBorders" style="border-collapse: collapse;" border="0" cellspacing="0" cellpadding="2"
|- align="left" valign="top"
| width="1189" style="border: 1px solid rgb(1, 1, 1);" colspan="2" |
== Field: Qualification level ==

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Type

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
Number

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
General Description

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
This is the skill level the user has for a specific qualification

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Import Group

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
Import Qualification Information

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Business Rules

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*Qualification level is only one part of importing qualification. It must go along with qualification to actually succeed.
*Value in this field must match the range [minimum value, maximum value] of the qualification (all qualifications in Catglobe have a user defined minimum and maximum value – please refer to information on how to manage qualifications to know more).
*To update this field for existing users, you must select a User_Id column in step 1 of the import wizard and the value of this column will be used to determine which user’s record to update.
* Value -1 for clear Qualification level on user

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Validation

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*If value is not a number, then invalid value error message will be shown. Error type: ERROR (the import job will not be allowed to be executed).
*If value is not in the range of [min,max] of the qualification name, then an out of range error message will be shown. Error type: ERROR (the import job will not be allowed to be executed).
*If a qualification level is specified in import for a row, but no qualification, then the message ‘Qualification does not exist’ will be shown in step 5 to let user know that data is not clean. Error type: ERROR (the import job will not be allowed to be executed).

|- align="left" valign="top"
| width="168" style="border: 1px solid rgb(1, 1, 1);" |
Notes

| width="1021" style="border: 1px solid rgb(1, 1, 1);" |
*Please refer to help file on Qualification to understand all parts of importing qualifications.

|}

[[Category:Import_module]]

Qualification removeLevelOnUsers

2026-07-24T02:38:21Z

Antester@voxmeter.dk1: