Products
Contact Support Additional Learning Monthly Product Updates
Menu

Forsta CATI Support

All the topics, resources needed for Forsta CATI.

Appendix A - Action Parameter Descriptions

  • Last updated:

Articles in this section

In this article

    This is the list of the scheduling script actions and descriptions of their parameters.

    Action name

    Parameter

    Description

    Usage

    		Comment

    Suspend the interview

    		n/aPlaces the call into the "Not Scheduled" list while maintaining it's current status. 

    Terminate the interview

    		n/aPlaces the call into the "Not Scheduled" list while changing it's current status to be "Terminated". 

    Set time to NOW

    0 or 1

    Enter 0 for a Shift type = “None”, or 1 for a Shift type = “Any Valid”.

    		The value specifies the time to call for the particular shift. "0" indicates that the call will be made regardless of the shift, "1" indicates that the call will be made only for the appropriate shift.Generates a call. Schedules the call

    Fulfill the specified appointment

    number, min = 0

    Enter the number of minutes before the appointment time. The value must not be empty.

    		Sets the time to call ASAP. The call will be made n minutes before the appointment time. The minimum value is "0" - this indicates the current time.Generates a call. Schedules the call

    Recall after a number of minutes

    number, min = 1

    Enter the number of minutes

    		Specifies the time to recall as n minutes after the call has ended.Generates a call. Schedules the call. Sets Time to Call.

    Recall after a number of shifts

    number, min = 1

    Enter the number of shifts. "1" indicates the next shift.

    		Specifies the time to recall as n shifts after the current shift. Time to call is set precisely at the shift start.Generates a call. Schedules the call. Sets Time to Call.

    Recall after a number of shifts (random time)

    number, min = 1

    Enter the number of shifts. "1" indicates the next shift.

    		Specifies the time to recall as n shifts after the current shift. Time to call is set randomly (whenever the call can be made) within the specified shift.Generates a call. Schedules the call. Sets Time to Call.

    Recall on the next shift of the specified type

    number, range = Shift Type ID

    Enter the Shift Type ID. Only existing Shift Type ID values are supported.

    		Specifies the time to recall for the specified shift type. Time to call is set precisely at the shift start.Generates a call. Schedules the call. Sets Time to Call.

    Recall on the next shift of the type specified by variable

    String

    Enter a quantity variable name. The survey must contain the referred variable.

    		Specifies the time to recall for the specified shift type. Time to call is set precisely at the shift start.Generates a call. Schedules the call. Sets Time to Call.

    Recall after a number of shifts specified by variable

    String

    Enter a quantity variable name. The survey must contain the referred variable.

    		Specifies the time to recall for the specified shift type. Time to call is set precisely at the shift start.Generates a call. Schedules the call. Sets Time to Call.

    Recall on the specific shift

    number, range = Shift ID

    Enter the Shift ID. Only existing Shift ID values are supported.

    		Specifies the time to recall for the specified shift type. Time to call is set precisely at the shift start.Generates a call. Schedules the call. Sets Time to Call.

    Recall on the shift specified by variable

    String

    Enter a quantity variable name. Variable value can be set to the specific shift name, or to "None".

    		Specifies the time to recall for the specified shift type. Time to call is set precisely at the shift start. Shift name set to "None" will cause the call to be made at the start of the appropriate shift.Generates a call. Schedules the call. Sets Time to Call.

    Recall on specific time

    valid date and time, dd/mm/yyyy hh:mm

    Enter the time value in the following format: dd/mm/yyyy hh:mm. Only valid date and time values are supported.

    		Specifies the time to recall within the current shift.Schedules the call. Sets Time to Call.

    Set Next Rule

    number, range = Rule number

    Enter the Next Rule ID. Only existing Rule ID values are supported.

    		Specifies the number of rule for the next call to start searching from. This means that rules in the list to be used for the next call are searched forward starting with the specified rule. Generates a call. Updates the call properties

    Set new Extended Status

    number, Min = 1, Max = 120

    Enter the new Extended Status

    		Changes the Extended Status of a call.Updates the call properties

    Set new Call Priority

    number, min = 1

    Enter the new call priority value

    		Changes the Priority value of a call.Generates a call. Updates the call properties

    Increment Priority

    number, min = 1

    Enter the value to increment the current priority by

    Increments the Priority value of a call by the specified value.

    		Generates a call. Updates the call properties

    Decrement Priority

    number, min = 1

    Enter the value to decrement the current priority by

    		Decrements the Priority value for a call by the specified value.Generates a call. Updates the call properties

    Assign User/Group(s)

    number, Person ID or Group ID, -1, -2, -3

    Enter Interviewer ID or Group ID or a list of Group IDs separated by comma, -1 for "Unchanged", -2 for "Last Person", -3 to set no specific assignment

    		Assigns a specified person/group to a specified interview, or removes the specified assignment. Also creates a multiple assignment in case a number of groups is specified.Generates a call. Updates the call properties

    Set Call expiration timeout

    number, min = 1

    Enter the timeout value in minutes

    Sets the expiration timeout counting from the specified Time to Call.

    Should be used ONLY along with an action that sets 'Time To Call' (e.g. Recall after a number of Shifts, Recall on Specific Time and similar actions can be used to that end - see action description in the Comment column).

    		Generates a call. Updates the call properties

    Set Call expiration time

    valid datetime, dd/mm/yyyy hh:mm

    Time format: dd/mm/yyyy hh:mm

    Sets the expiration time of a call.

    Should be used ONLY along with an action that sets 'Time To Call' (e.g. Recall after a number of Shifts, Recall on Specific Time and similar actions can be used to that end - see action description in the Comment column).

    		Generates a call. Updates the call properties

    Set Shift Type

    number, Shift Type ID, 0, -1

    Enter the Shift Type ID, 0 for "Any Valid", -1 for "None"

    		Specifies the shift type, during which the call will be due.Generates a call. Updates the call properties

    Increment quantity variable

    String

    Enter a quantity variable name

    		Increments the quantity variable value by one. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Special increment quantity variable

    String

    Enter a quantity variable name

    		Increments the quantity variable value by one. Should be applied in case the Extended Status of a call has not changed since the last time. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Decrement quantity variable

    String

    Enter a quantity variable name

    		Decrements the quantity variable value by one. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Special decrement quantity variable

    String

    Enter a quantity variable name

    		Decrements the quantity variable value by one. Should be applied in case the Extended Status of a call has not changed since the last time. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Reset quantity variable

    String

    Enter a quantity variable name. The specified variable must allow zero values.

    		Changes the variable value to a zero. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Special reset quantity variable

    String

    Enter a quantity variable name

    		Changes the variable value to a zero. Should be applied in case the Extended Status of a call has not changed since the last time. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Assign value to quantity variable

    string, quantity variable name = value

    Enter a quantity variable name and its value.

    		Assigns a new value to the variable. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Assign function call result to variable

    string, quantity variable name = function name

    Enter a quantity variable name and a function name

    		Assigns the result of a function call to a specified variable. Can only be used with normal variables (not to be used with background variables).Updates the call properties

    Add a group to a multiple assignment

    number(s), Group ID(s)

    Enter a group ID or a list of Group IDs separated by commas

    		Adds a group or a number of groups to an already existing multiple assignment. This action does not replace an existing assignment!Updates the call properties

    Remove a group from a multiple assignment

    		number(s), Group ID(s)

    Enter a group ID or a list of Group IDs separated by commas

    		Removes a group or a number of groups from an already existing multiple assignment.Updates the call properties

    Go To

    string, SubRule number

    Enter the sub-rule number. Current sub-rule number is not allowed.

    		Specifies the sub-rule to be executed next (right after the current action). 

    Run custom script

    		n/a

    Enter the name of the function contained in the custom script

    		Specifies the custom script to be run.Generates a call.

    Stop execution

    		n/aStops the current rule execution. Search for the next rule is canceled.  
    Set dialing mode2 or 0Enter "2" for switching to Preview dial mode, or "0" to reset the dial mode to the survey-level dial mode setting.Temporarily switches a single interview to the Preview mode when the Predictive mode is set for the whole survey. Updates the call properties
    Disable calln/a Prevents a call from being delivered to an interviewer while retaining all of its properties - sets the "Disabled" mark for the selected call(s).Generates a call. Updates the call properties
    Enable calln/a Turns a disabled call back into a regular call (removes the "Disabled" mark). Generates a call. Updates the call properties
    Restore previous call attributesn/a Restores all call atributes that were specified for that call before it was assigned the Returned Not Dialed or Returned Dialer Expired extended status.Updates the call properties