Connector Script Guidelines

Creating Scripts for Testing > Using Scripts to Simulate IC and CTI Connectors > Creating a Connector Script > Connector Script Guidelines

	Connector Script Guidelines

When creating your script, use the following guidelines:

Note:

For sample scripts that illustrates these guidelines and that you can use as a model, or starting point, for your own scripts, see Sample Connector Scripts.

The script must begin with the following code as the first line of the file:

<?xml version="1.0" encoding ="UTF-8"?>

The second and last lines of the file must read as follows:

</simulator>

Nested between these two tags, you must identify the connector for which the script works, using the following format:

<connector name="connectorType"

</connector>

where connectorType represents the type of connector for which this part of the script works. Valid values for this field include:

Note:

If required, you can include one connector entry for each connector type between the simulator tags. That is, you can have one section of your script, between connector tags for each type of connector, both IC and CTI. You should not, however, include multiple connector tags for a single connector type within the same script. If you do, the simulator acts upon the first one and ignores any other connector configurations for that connector type.

Nested between each set of connector tags, you configure the commands you want the script to support for that connector simulator.

The command tag set uses the following format:

</command>

where commandName is the command you want to configure.

For more information about the commands for each connector type, see Summary of Connector Commands.

You can include multiple command entries between each set of connector tags.

Within each command entry, you must have one or more sets of configurations. A configuration is a block of XML code in which you define the behavior of the connector simulator for that command. Each configuration is contained within a set of configuration tags that use the following format:

<configuration>

</configuration>

Each configuration is made up of sets of comparisons and actions:

A comparison instructs the simulator to compare an input received during the call with a certain value. If the comparison evaluates as true, the simulator is to take the corresponding action or actions.

A comparison uses the following format:

<compare type="type" field="field" value="value" />

where:

type represents the type of comparison the simulator is to make. Possible values include:

EQUAL - Defines a field and a value to compare. With this type, both the field and value elements are required. You can use the asterisk (*) as a wildcard for the value element.

ALL - Instructs the simulator to take the action in every case. With this type, you do not use either the field or the value element.

field is a predefined value that must correspond with the command being configured. For more information, including the fields that are valid for each command, see Summary of Connector Commands.

value is the value that the field must have to result in an evaluation of true. If you want to allow any value for the field to evaluate as true, you can use the asterisk (*) as a wildcard.

An action instructs the simulator what action to take when the requisite comparison or comparisons evaluate as true.

An action uses the following format:

<action type="type" field="field" value="value" />

where:

type is a predefined action that the command can take. For more information, including the types that are valid for each command, see Summary of Connector Commands.

field is either blank or the name of a known variable or variable field in Dialog Designer.

value is the value to be assigned to the variable or variable field designated in the field element.

A special case action is the error condition. To simulate an error for any command, use the following general format:

<action type="ERROR" field="" value="errorMessage"/>

Note that the field element is empty. When the simulator encounters an action with this format, the simulator returns the errorMessage.

For more information about other configuration options, see Additional Configuration Options in Connector Scripts.