Script on Cati call - Revision history

Nguyenduyan at 09:45, 26 June 2025

2025-06-26T09:45:57Z

← Older revision		Revision as of 09:45, 26 June 2025
Line 21:		Line 21:

	<source lang="javascript">		<source lang="javascript">
	//Example script to ~~set disable user who reach max call and~~ remove the user from a group		//Example script to add/remove the user to/from a group
	array a = Workflow_getParameters();		array a = Workflow_getParameters();
	array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts		array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
Line 29:		Line 29:
	number maxCallLimit = 5;//your limit		number maxCallLimit = 5;//your limit
	if(timesCalled >= maxCallLimit){		if(timesCalled >= maxCallLimit){
			Group_addUser(user.ResourceId, groupAdd) ;//yourGroup
	Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup		Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup
	~~//Group_addUser(user.ResourceId, groupAdd) ;//yourGroup~~
	~~user.Disabled = true;~~
	~~user.Save();~~
	}		}
	</source>		</source>

2025-06-26T09:43:12Z

← Older revision		Revision as of 09:43, 26 June 2025
Line 37:		Line 37:

	[[File:2018-05-23_15-39-30.png]]		[[File:2018-05-23_15-39-30.png]]

			Please note that if the code has an error, it will not be thrown; Cati will continue to call normally.
			If you want to catch errors, you should use a try-catch block and send the error back to yourself.

			<source lang="javascript">
			object e;
			try{
			//do something
			}catch(e){
			sendEmail("yourEmail","Alias","Subject",e.Message,"fromEmail");
			}
			</source>

2025-06-26T09:25:34Z

← Older revision		Revision as of 09:25, 26 June 2025
Line 29:		Line 29:
	number maxCallLimit = 5;//your limit		number maxCallLimit = 5;//your limit
	if(timesCalled >= maxCallLimit){		if(timesCalled >= maxCallLimit){
	Group_removeUser(user.ResourceId, ~~groupId~~) ;//yourGroup		Group_removeUser(user.ResourceId, groupRemove) ;//yourGroup
			//Group_addUser(user.ResourceId, groupAdd) ;//yourGroup
	user.Disabled = true;		user.Disabled = true;
	user.Save();		user.Save();

2025-06-26T09:14:57Z

← Older revision		Revision as of 09:14, 26 June 2025
Line 21:		Line 21:

	<source lang="javascript">		<source lang="javascript">
			//Example script to set disable user who reach max call and remove the user from a group
	array a = Workflow_getParameters();		array a = Workflow_getParameters();
	array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts		array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
	number timesCalled = a[1];		number timesCalled = a[1];
	....		//QAS qas = QAS_getCurrentQAS();//The qas context is the dialed qas
			User user = User_getQasUser();//The current user context is set to the user of the qas
			number maxCallLimit = 5;//your limit
			if(timesCalled >= maxCallLimit){
			Group_removeUser(user.ResourceId, groupId) ;//yourGroup
			user.Disabled = true;
			user.Save();
			}
	</source>		</source>

	[[File:2018-05-23_15-39-30.png]]		[[File:2018-05-23_15-39-30.png]]

2021-11-18T10:22:11Z

← Older revision		Revision as of 10:22, 18 November 2021
Line 1:		Line 1:
	[[Category:~~Questionnaire_module~~]]		[[Category:CATI_module]]
	= Script on Cati call =		= Script on Cati call =
	Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.		Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.

2019-05-09T07:51:15Z

Setup

← Older revision		Revision as of 07:51, 9 May 2019
Line 13:		Line 13:

	== Setup ==		== Setup ==
	Define ~~script~~ at CATI setting on Fieldwork management:		Define "Script to execute after call" at CATI setting on Fieldwork management:

	[[File:2018-05-23_15-25-57.png]]		[[File:2018-05-23_15-25-57.png]]

2018-05-23T08:46:55Z

← Older revision		Revision as of 08:46, 23 May 2018
Line 1:		Line 1:
	[[Category:~~Questionnaire_Functions~~]]		[[Category:Questionnaire_module]]
	= Script on Cati call =		= Script on Cati call =
	Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.		Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.

2018-05-23T08:44:58Z

← Older revision		Revision as of 08:44, 23 May 2018
Line 6:		Line 6:
	The script gets the following parameters:		The script gets the following parameters:

	1. The current cati contact in same format as returned from CATI_getCATIContacts		1. The current cati contact in same format as returned from [[CATI_getCATIContacts]]

	2. Times called		2. Times called

2018-05-23T08:43:48Z

← Older revision		Revision as of 08:43, 23 May 2018
Line 1:		Line 1:
	[[Category:Questionnaire_Functions]]		[[Category:Questionnaire_Functions]]
			= Script on Cati call =
			Add the ability to call a script after each time a number has been dialed, also set via the cati settings. This will allow us better control of when to do various stuff, and also allow custom logic for some cases... e.g. in the rerecruitment we can say that when it reach the maxdial status, then we opt people out of panel. Or we can send SMS to people with answering machines that we will call them back.
			It should be noticed that the calling of this script is on the critical path, and must therefore be severely restricted in the amount of work done, ie in the case of sending SMS, the only thing the script should do is add respondent to a group and another script scheduled to run e,g. every 30 min takes care of the actual sending of SMS.

			The script gets the following parameters:

			1. The current cati contact in same format as returned from CATI_getCATIContacts

			2. Times called

			The current user context is set to the user of the qas, and the qas context is the dialed qas.

			== Setup ==
			Define script at CATI setting on Fieldwork management:

			[[File:2018-05-23_15-25-57.png]]


			Script on Workflow:

			<source lang="javascript">
			array a = Workflow_getParameters();
			array currentCatiContact = a[0];//same format as returned from CATI_getCATIContacts
			number timesCalled = a[1];
			....
			</source>

			[[File:2018-05-23_15-39-30.png]]

2018-05-23T08:19:55Z

New page

[[Category:Questionnaire_Functions]]