In this article
The scheduling script settings include specifications for the time period (the “shift”), the system event and the interview state. These settings define when this script is to be run.
- Shifts - A "Shift" defines the particular recurring time periods during which the script can be run. The shift start and end are indicated by the day of the week and the time within that day. The set of shifts you specify for a week is then repeated each week for one year (the default parameter used by the CATI Supervisor module). Note that shifts in a single time zone cannot overlap.
- Exclusions - To help you fine tune the schedule, the CATI Supervisor module allows you to specify exclusions. These are one-time periods during which the script will not be active. This allows you to exclude for example holidays or particular time and date ranges from the schedule. Exclusions do not recur. An exclusion's start and end times are specified by dates and times within those dates.
For example, you have scheduled a script to run each Monday and Wednesday starting at 09:00, and ending at 18:00. The script will run each Monday and Wednesday for a period of one year from the first day it was run, from 09:00 to 18:00. However a state holiday falls on a Monday and you do not want the script to function that day, so you exclude this particular date from the schedule.
Shifts and exclusions are specified only for a particular time zone; you cannot assign the same shift or exclusion to different time zones. See Configuring the Master Timezone list and Configuring the Active Timezone list for more details on time zones.
All shifts are grouped according to the user’s preferences. Such groups are called “Shift Types”. Shift types are used to logically separate shifts – they can be grouped by the time of day, or by another logical attribute to facilitate the creation of scheduling rules (go to Specifying Shifts and Exclusions for more information).
- The other important scheduling script parameter is a set of rules that describe the interview states that trigger the script. Rules consist of sub-rules and actions which are used to instruct the system what to do with a call (an interview) when it is finished. These instructions are normally used to set a new recall time so that a call could reach a respondent.
- A sub-rule defines a condition, and a set of actions which will be executed if these condition criteria are satisfied.
- An action is a single instruction to the system to execute a single action for a call.
A scheduling script configuration procedure starts with specifying the required shift types. One you have specified the shift types, and the shifts belonging to each type, you can then proceed with adding rules. Note that the rules are specified for particular shifts.
The configured scheduling script can be discarded, saved, or saved and launched simultaneously. A saved script is stored in the Forsta database and can be accessed for editing or launching at any time. A launched script is scheduled for execution according to the specified rules.
Viewing the Existing Scheduling Script Settings
You can view and modify the settings of any of the scripts displayed in the list. To do this:
- In the main menu bar go to the Scheduling tab.
- Either right-click the required script in the list and choose View from the shortcut menu, or select the required script and click the View button in the toolbar.
The list of scheduling scripts opens.
The selected script's settings are displayed in the lower frame.
Figure 1 - Viewing the script settings in the bottom right frame
A number of tabs are used to display the settings:
- Rules – used for specifying rules to be applied to the call (go to Specifying Rules for more information).
- Shifts – used for specifying shifts during which the script should be active (go to Specifying Shifts and Exclusions for more information).
- Shift types – used for specifying shift types (shift types are required for correct specification of the shifts) (go to Specifying the Shift (Exclusion) Type for more information).
- Parameters - used for managing parameters which can be used with any action added to the script (go to Creating Parameters for more information).
- Custom script – allows you to enter custom code you may wish to use with the script. This code will be executed when the “Run specified script” action is defined for a sub-rule (go to Writing a Custom Scheduling Script Code for more information).
The toolbar in the frame title bar contains the selected scheduling script name and a set of controls different for each tab.
Searching for a Particular Rule, Sub-rule or Action in the Scheduling Rules List
You can search the scheduling rule list to find a rule, sub-rule or action which has an attribute value matching a specified condition. To search the scheduling rule list:
- With the scheduling script opened in the View mode, choose the Rules tab in the lower frame.
- Click the Search button in the frame's title bar.
- In the Search type drop-down box select an attribute to search through. Enter the search string in the Search text field; wild-cards are supported.
- Click the Find next button. The first item with the selected attribute value matching the search condition will be highlighted in the list.
- Click the Find next button again to highlight another match.
- Click Cancel to close the dialog .
The search dialog opens.
Figure 2 - Searching the scheduling rule list
Copying and Pasting Scheduling Rule Items
To copy and paste scheduling rule items:
- With the scheduling script opened in the View mode, go to the Rules tab in the lower frame.
- Select a rule, sub-rule, or action and right-click on it.
- Select the row in the grid where you wish to paste the copied item. Note that the item will still be inserted on the appropriate hierarchy level – a rule on a rule level, a sub-rule on a sub-rule level etc.
- Right-click the selected row or click the Paste button
in the toolbar.
The item is copied. Note that "sibling" items are not copied.
The item is pasted below the selected the row taking into account the script hierarchical structure.