Difference between revisions of "CatiSettings class"
(Tag: visualeditor) |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
|Name=<nowiki>CatiSettings</nowiki> | |Name=<nowiki>CatiSettings</nowiki> | ||
|Description=<nowiki>Settings for cati questionnaires.</nowiki> | |Description=<nowiki>Settings for cati questionnaires.</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire</nowiki>}} | ||
| Line 8: | Line 8: | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save settings.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save settings.</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetOutcomeSetAndSave</nowiki>|Parameters= |
| + | {{CGscriptParameters_Template|Type=OutcomeSet|Name=<nowiki>set</nowiki>|Description=<nowiki>Outcome set to update to</nowiki>}} | ||
| + | |Description=<nowiki>Change the outcome set of the questionnaire.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AfterCallScriptResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After saving outcome status for a call, invoke this script. It gets 2 parameters: The chosen outcome, see CATI_getCATIContacts and the number of times called. The current context is set the the qas.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AfterCallScriptResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After saving outcome status for a call, invoke this script. It gets 2 parameters: The chosen outcome, see CATI_getCATIContacts and the number of times called. The current context is set the the qas.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AstParam</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Comma seperated list of parameters to send to the dialplan in asterisk when initiating a call (Requires dialplan support).</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AstParam</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Comma seperated list of parameters to send to the dialplan in asterisk when initiating a call (Requires dialplan support).</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=Phonenumber|Name=<nowiki>CallerId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the caller id. Ensure you have legal rights to display this number. Set to empty to use the global default.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ChanceForInterviewerNeeded</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When using predictive, when cold-dialing the first couple of numbers what is the chance to get picked up. This determines how many predictive calls to make.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ChanceForInterviewerNeeded</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When using predictive, when cold-dialing the first couple of numbers what is the chance to get picked up. This determines how many predictive calls to make.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ContactLimit</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Maximum number of calls to a single qas, before being excluded.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DialerType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Which dialer to use. 0 = Auto dial, 1 = Auto pick, but don't start dialing until user ok, 2 = Auto pick, but don't use Voip/Asterisk, 3 = Predictive dialing.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DialerType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Which dialer to use. 0 = Auto dial, 1 = Auto pick, but don't start dialing until user ok, 2 = Auto pick, but don't use Voip/Asterisk, 3 = Predictive dialing.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FirstPageQuestion</nowiki>|HasGetter=1|Description=<nowiki>Get the html of the text shown on the first page of the questionnaire to display before qas is started.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>HighPriorityTimeFrameAfter</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When scheduling a meeting/retry how many minutes after is it ok to pick, before picking other on-time appointments.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>HighPriorityTimeFrameBefore</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When scheduling a meeting/retry how many minutes before is it ok to pick.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>HighPriorityTimeFrameBefore</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When scheduling a meeting/retry how many minutes before is it ok to pick.</nowiki>}} | ||
| − | |||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MaxDialingThreads</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When using predictive, how many maximum call attempts can happen at the same time.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MaxDialingThreads</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When using predictive, how many maximum call attempts can happen at the same time.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=OutcomeSet|Name=<nowiki>OutcomeSet</nowiki>|HasGetter=1|Description=<nowiki>Get the outcome set.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PickTimeout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When call is finished, how long in seconds does the interviewer have to pick an outcome before it is picked automatically.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PickTimeout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When call is finished, how long in seconds does the interviewer have to pick an outcome before it is picked automatically.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>SuccessPerHour</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Number of expected successes an interviewer per hour is expected to do to get 100% performance. This can be altered throughout the duration of the project to reflect harder to get quotas.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>SuccessPerHour</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Number of expected successes an interviewer per hour is expected to do to get 100% performance. This can be altered throughout the duration of the project to reflect harder to get quotas.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimeoutExceed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After how many minutes is an ongoing qas seen as lost and put back in queue. Use negative to disable.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimeoutExceed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After how many minutes is an ongoing qas seen as lost and put back in queue. Use negative to disable.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
| − | |||
=== <span style="color:#DF8621">'''Note'''</span> === | === <span style="color:#DF8621">'''Note'''</span> === | ||
<span style="color:#DF8621">AfterCallScriptResourceId</span> | <span style="color:#DF8621">AfterCallScriptResourceId</span> | ||
see more [[Script on Cati call|here]] | see more [[Script on Cati call|here]] | ||
| + | |||
| + | === <span style="color:#DF8621">'''Examples'''</span> === | ||
| + | <source lang="javascript"> | ||
| + | //set CallerId | ||
| + | CatiSettings c = new CatiSettings (qnaireId); | ||
| + | c.CallerId = new Phonenumber({PhoneNumber_Type_Main1, "88888888", 45}); | ||
| + | //c.CallerId = empty;//set empty CallerId | ||
| + | c.Save(); | ||
| + | </source> | ||
Latest revision as of 10:17, 28 June 2024
CatiSettings
Settings for cati questionnaires.
Parent class
Inherits from object
Constructors
- (int questionnaireResourceId "Resource id of the questionnaire") - Load existing settings for questionnaire.
Methods
- Empty Save() - Save settings.
- Empty SetOutcomeSetAndSave(OutcomeSet set "Outcome set to update to") - Change the outcome set of the questionnaire.
- (From object) string ToString() - The string representation of the object.
Properties
- int AfterCallScriptResourceId { get; set; } - After saving outcome status for a call, invoke this script. It gets 2 parameters: The chosen outcome, see CATI_getCATIContacts and the number of times called. The current context is set the the qas.
- string AstParam { get; set; } - Comma seperated list of parameters to send to the dialplan in asterisk when initiating a call (Requires dialplan support).
- Phonenumber CallerId { get; set; } - Get/Set the caller id. Ensure you have legal rights to display this number. Set to empty to use the global default.
- number ChanceForInterviewerNeeded { get; set; } - When using predictive, when cold-dialing the first couple of numbers what is the chance to get picked up. This determines how many predictive calls to make.
- int ContactLimit { get; set; } - Maximum number of calls to a single qas, before being excluded.
- int DialerType { get; set; } - Which dialer to use. 0 = Auto dial, 1 = Auto pick, but don't start dialing until user ok, 2 = Auto pick, but don't use Voip/Asterisk, 3 = Predictive dialing.
- string FirstPageQuestion { get; } - Get the html of the text shown on the first page of the questionnaire to display before qas is started.
- int HighPriorityTimeFrameAfter { get; set; } - When scheduling a meeting/retry how many minutes after is it ok to pick, before picking other on-time appointments.
- int HighPriorityTimeFrameBefore { get; set; } - When scheduling a meeting/retry how many minutes before is it ok to pick.
- int MaxDialingThreads { get; set; } - When using predictive, how many maximum call attempts can happen at the same time.
- string ObjectTypeName { get; } - The name of the type of object.
- OutcomeSet OutcomeSet { get; } - Get the outcome set.
- int PickTimeout { get; set; } - When call is finished, how long in seconds does the interviewer have to pick an outcome before it is picked automatically.
- number SuccessPerHour { get; set; } - Number of expected successes an interviewer per hour is expected to do to get 100% performance. This can be altered throughout the duration of the project to reflect harder to get quotas.
- int TimeoutExceed { get; set; } - After how many minutes is an ongoing qas seen as lost and put back in queue. Use negative to disable.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Note
AfterCallScriptResourceId see more here
Examples
//set CallerId
CatiSettings c = new CatiSettings (qnaireId);
c.CallerId = new Phonenumber({PhoneNumber_Type_Main1, "88888888", 45});
//c.CallerId = empty;//set empty CallerId
c.Save();
