Creating Parameters

The supervisor can create a set of parameters for each available scheduling script. Parameter set is added to each script individually. Any parameter from the set can be used with any appropriate action contained in the script. The scheduling script which uses parameters from this set is called the "parameterized" scheduling script. A parameter is considered as "used in the script" not when it is added to the script, but only when it is selected as a parameter for an action which is used in the scheduling script rule.

No more than 30 parameters are allowed in a single scheduling script.

Parameter set for a scheduling script is created using the Parameters tab in the bottom right frame when the Script View is displayed. The parameter set added on the Parameter tab of the Script View is available company wide - it can be used with any survey which uses that script. These parameter values are considered as default values.

CATI Supervisor also allows modifying the default values of the parameterized scheduling script for each survey individually - this can be done using the Scheduling Parameters tab of the Survey Information view (see Viewing and Modifying Parameters of the Scheduling Script for details).

The scheduling script parameter set can be modified - parameters can be added and deleted at any time. Before deletion CATI Supervisor always checks if the parameter to be deleted is currently used with some action.

The parameterized scheduling script needs to be saved and re-launched each time any parameter setting is modified.

Adding a Parameter to the Scheduling Script

1. Display the Script View in the bottom frame for the required scheduling script (go to Viewing the Existing Scheduling Script Settings for more information).
2. Go to the Parameters tab.

If no parameters have been added to the script as yet the tab will be empty. Otherwise the available parameters are listed.



Figure 1 - Viewing the scheduling script parameter set

3. Either click the New Parameter button on the toolbar or right-click any grid row and choose New Parameter from the context menu that appears.

The New Parameter dialog opens.



Figure 2 - Adding a parameter to the scheduling script

4. Enter the Name and Description of the parameter in the appropriate fields.
5. Choose the parameter type from the Type drop-down list. The following types are supported:
• Numeric - an integer. Can be used with any action which supports numerical values.
• Shift - values that are supported for use with the appropriate action (go to Appendix A - Action Parameter Descriptions for more information).
• Shift type - values that are supported for use with the appropriate action (go to Appendix A - Action Parameter Descriptions for more information).
• Assignment - values that are supported for use with the Assign User/Group action (go to Appendix A - Action Parameter Descriptions for more information).
• Extended status - the Extended status ID.
6. Enter the required default parameter value in the Default Value field.

This value will be used for all actions with which this parameter is used (go to Specifying Rules for more information).

7. Click Add to add the created parameter, or Cancel to close the dialog and discard any changes.

Editing an existing parameter

1. Display the Script View in the lower frame for the required scheduling script (go to Viewing the Existing Scheduling Script Settings for more information).
2. Go to the Parameters tab, select the required parameter in the list and either click the Edit button on the toolbar, or right-click in the row and choose Edit from the context menu that appears.

The Add Parameter dialog opens with the current values.

3. Modify the values as required.
4. Click Add to save the modified parameter or Cancel to close the dialog and discard any changes.

Deleting an existing parameter

1. Display the Script View in the lower frame for the required scheduling script (go to Viewing the Existing Scheduling Script Settings for more information).
2. Go to the Parameters tab, select the required parameter and either click the Delete button on the toolbar or right-click in the row and choose Delete from the context menu that appears.

A confirmation dialog opens.

3. Click OK to delete the parameter or Cancel to close the dialog without deleting.

Saving and optionally launch the saved script

To check the system you should save and launch the scheduling script after you change parameter settings.

Click the Save button on the toolbar to save the current scheduling script, or click the Save and Launch button on the toolbar to save and launch the script.