Difference between revisions of "CatiSettings class"

From Catglobe Wiki
Jump to: navigation, search
Line 37: Line 37:
 
<source lang="javascript">
 
<source lang="javascript">
 
//set CallerId
 
//set CallerId
User user = User_getUserByResourceId(UserId);
 
user.PhoneNumbers = {
 
{PhoneNumber_Type_Home1, 8888888888, 84}
 
};
 
 
CatiSettings c = new CatiSettings (qnaireId);
 
CatiSettings c = new CatiSettings (qnaireId);
c.CallerId=user.PhoneNumbers[0];
+
c.CallerId = new Phonenumber(PhoneNumber_Type_Main1, "88888888", 45);
 
c.Save();
 
c.Save();
 
</source>
 
</source>

Revision as of 05:06, 26 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.Save();