Summary of Connector Commands

This section lists and describes all the commands that can be used in conjunction with connector scripts. The commands are divided into the following groups:

The following table lists and describes the IC connector commands that can be included in connector scripts.

IC Connector Commands
Command Name	Valid Comparison Field Values	Valid Action Type Values	Default Action¹
Alarm	alarmname - Contains the name of the alarm, as defined in the Alarm item	ERROR	The simulator returns an indication of a successful alarm.
CallGone	VDUID - Contains the value of the vdu variable id field	ERROR	The simulator returns a successful "call gone" response
GetVDU	VDUID - Contains the value of the vdu variable id field Name - Contains the name of the workflow	ERROR	The simulator looks up in the simulator VDU table the requested id value and returns the value. If the value is not in the VDU table, the simulator returns an error.
NewCall	Channel - Contains the value of the channel on which the call is coming in.	ERROR SET_VDU_ID	The simulator returns the value of the SET_VDU_ID action type to the value of the vdu variable id field.
SetVDU	VDUID - Contains the value of the vdu variable id field Name - Contains the name of the workflow	ERROR	The simulator sets the value of the value element in the simulator VDU table and returns a response to the effect that the value was set correctly.
Transfer	VDUID - Contains the value of the vdu variable id field	ERROR	The simulator returns a successful call transfer response.
InvokeWorkflow	VDUID - Contains the value of the vdu variable id field workflow - Contains the name of the workflow to invoke	ERROR SET_OUTPUT - The field for this type must be the name of a variable that matches the name of a variable on the IC system. SET_VDU - The field for this type must be the name of a custom field in the vdu variable.	The simulator returns a response to the effect that the workflow ran successfully. At the same time, the simulator sets the designated variables with the values from the SET_OUTPUT and SET_VDU action types.

¹The default action is the action that the simulator performs when no comparison evaluates as true.

The following table lists and describes the CTI connector commands you can include in connector scripts:

CTI Connector Commands
Command Name	Valid Comparison Field Values	Valid Action Type Values¹	Default Action²
CallInfo	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call information was successfully obtained.
Conference	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call was successfully conferenced in.
Dial	PhoneNumber - Contains the value of the Dial Number variable from the Dial (CTI) item	ERROR - Error codes for return include: busy failed noanswer unreachable unknown	The simulator returns a response that the number was successfully dialed (with an "established" state). Before transferring a call, the state of the Dialed call should be selected.
Disconnect	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call was successfully disconnected (with a "disconnected" state).
Hold	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call was successfully placed on hold (with a "held" state).
Retrieve	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call was successfully retrieved from hold status (with an "established" state).
Transfer	*	ERROR - The error code to be returned is defined in the value element.	The simulator returns a response that the call was successfully transferred (with a "transferred" state).

¹Use the value field to return the error code.

²The default action is the action that the simulator performs when no comparison evaluates as true.

Creating Scripts for Testing > Using Scripts to Simulate IC and CTI Connectors > Creating a Connector Script > Summary of Connector Commands

	Summary of Connector Commands