Bookshelf Home | Contents | Index | Search | PDF

Siebel Communications Server Administration Guide > Developing a Communications Driver > Siebel Adaptive Communications API Reference >

Constants for Communications Drivers

---

Each of the following elements enumerates one or more constants. Values for all fields are stored when information about objects is passed back and forth between the Siebel software and the communications driver.

For example, object information is passed in this manner when the client handle method UpdateObjectInformation is invoked. See UpdateObjectInformation.

SCCommandFlag

Communications commands have dynamic or runtime status, consisting of the bit-flags enumerated by SCCommandFlag. Zero or more bit-flags can apply to a given command at any given time.

NOTE:  In developing a driver, specify the names of the status flags, such as SC_CF_DISABLED, SC_CF_BLINKING, and so on, rather than the integer values.

enum SCCommandFlag
{
    SC_CF_NOTSUPPORTED  = 1,
    SC_CF_DISABLED      = 2,
    SC_CF_CHECKED       = 4,
    SC_CF_BLINKING      = 8,
    SC_CF_NOPARAMSOK    = 16,
    SC_CF_STRPARAMSOK   = 32
};

Each bit-flag that can be associated with a command is described below:

SC_CF_NOTSUPPORTED - The command is not supported.
SC_CF_DISABLED - The command is supported, but is disabled at this time.
SC_CF_CHECKED - The command is in a "checked" state—for example, when an agent is in Not Ready mode, the command to set the Not Ready state will be checked. This flag can be used to specify a toggle state for commands in the communications toolbar or in the Communications submenu of the View application-level menu.
SC_CF_BLINKING - Blinking is enabled for communications toolbar buttons, such as those for the Accept Work Item and Resume Work Item commands.
SC_CF_NOPARAMSOK - The command does not require any parameters to execute. For example, the commands for releasing a call and for toggling the Not Ready state do not require parameters.
SC_CF_STRPARAMSOK - The command can be executed by providing a single unnamed string parameter (no named parameter is provided). The command for placing a call, for example, requires only a single parameter. Such commands are invoked when the user types something in the input field in the communications toolbar—such as an extension number—and clicks the command's button.

NOTE:  If a device command's status excludes SC_CF_NOTSUPPORTED or SC_CF_DISABLED bit flags, then the command is considered enabled.

SCCommandTypeEx

Communications commands can be specified using either the InvokeCommand or InvokeCommandEx methods of the service handle. The values enumerated by SCCommandTypeEx specify the command type for an invocation of the InvokeCommandEx method. See InvokeCommandEx.

NOTE:  In developing a driver, specify the names of the command types, such as SC_CT_MAKECALL, rather than the integer values.

enum SCCommandTypeEx
{
    SC_CT_MAKECALL       = 1,
    SC_CT_SENDMESSAGE    = 2
};

Each command type is described below:

SC_CT_MAKECALL - The command to be invoked is a command for placing a phone call. The InvokeCommandEx command includes predefined parameters concerning the phone call to be made.
SC_CT_SENDMESSAGE - The command to be invoked is a command to send an email message. The InvokeCommandEx command includes predefined parameters concerning the email message to be sent.

SCErrorCode

The values enumerated by SCErrorCode specify predefined error codes. The error codes from 0 to 1000 are reserved.

NOTE:  In developing a driver, specify the names of the error codes, such as SC_EC_OK, SC_EC_ERROR, and so on, rather than the integer values.

enum SCErrorCode
{
    SC_EC_OK                       = 0,
    SC_EC_ERROR                    = 1,
    SC_EC_CMD_NOT_SUPPORTED        = 2,
    SC_EC_MEDIA_TYPE_NOT_SUPPORTED = 3,
    SC_EC_INVALID_HANDLE           = 4,
    SC_EC_OUT_OF_MEMORY            = 5,
    SC_EC_NETWORK_ERROR            = 6,
    SC_EC_LIB_LOAD_ERR             = 7,
    SC_EC_FUNC_NOT_RESOLVED        = 8,
    SC_EC_DRIVER_CREATION_ERR      = 9,
    SC_EC_DRIVER_RELEASE_ERR       = 10,
    SC_EC_SERVICE_CREATION_ERR     = 11,
    SC_EC_SERVICE_RELEASE_ERR      = 12,
    SC_EC_INVALID_ITEM_TRACKING_ID = 13,
    SC_EC_CLIENT_INTERFACE_ERR     = 14,
    SC_EC_SENDMSG_FAILED_RETRY     = 15,
    SC_EC_IMPOBJ_CREATE_ERR        = 16,
    SC_EC_INVALID_LICENSE          = 17,
    SC_EC_WORK_ITEM_WRONG_STATE    = 18,
    SC_EC_DRIVER_SPECIFIC          = 1000
};

Each error code is described below:

SC_EC_OK - The operation is successful.
SC_EC_ERROR - The operation failed.
SC_EC_CMD_NOT_SUPPORTED - The command is not supported.
SC_EC_MEDIA_TYPE_NOT_SUPPORTED - The channel type string is not recognized.
SC_EC_INVALID_HANDLE - Invalid handle.
SC_EC_OUT_OF_MEMORY - Out of memory.
SC_EC_NETWORK_ERROR - Networking error.
SC_EC_LIB_LOAD_ERR - Failure on loading the driver file.
SC_EC_FUNC_NOT_RESOLVED - Failure on resolving function address while invoking the command.
SC_EC_DRIVER_CREATION_ERR - Failure on creating the driver handle.
SC_EC_DRIVER_RELEASE_ERR - Failure on releasing the driver handle.
SC_EC_SERVICE_CREATION_ERR - Failure on creating the service handle.
SC_EC_SERVICE_RELEASE_ERR - Failure on releasing the service handle.
SC_EC_INVALID_ITEM_TRACKING_ID - Invalid tracking ID.
SC_EC_CLIENT_INTERFACE_ERR - Failure on invoking the ISC_CLIENT interface.
SC_EC_SENDMSG_FAILED_RETRY - SC_CT_SENDMESSAGE failed, please resend later.
SC_EC_IMPOBJ_CREATE_ERR - Unable to create the underlying implementation object.
SC_EC_INVALID_LICENSE - License error—used by the driver to report its license checking.
SC_EC_WORK_ITEM_WRONG_STATE - The work item is in the wrong state for the operation.
SC_EC_DRIVER_SPECIFIC - Specify for driver.

SCObjectProperty

Properties of monitored communications objects.

NOTE:  In developing a driver, specify the names of the object properties, such as SC_OP_ONOFF, SC_OP_AGENTID, and so on, rather than the integer values.

enum SCObjectProperty
{
       SC_OP_ONOFF         = 1,
       SC_OP_AGENTID       = 2,
       SC_OP_ISNOTREADY    = 4,
       SC_OP_ISBUSY        = 5,
       SC_OP_DESCRIPTION   = 7,
       SC_OP_TIMEINQUEUE   = 9,
       SC_OP_QUEUEID       = 12,
       SC_OP_ISLOGON       = 13
};

Each object property is described below:

SC_OP_ONOFF - A Boolean value indicating whether teleset control is on or off.
SC_OP_AGENTID - The ID number of an agent, for an agent or DN that is being monitored.
SC_OP_ISNOTREADY - A Boolean value indicating whether an agent has set the Not Ready state, for an agent or DN that is being monitored.
SC_OP_ISBUSY - A Boolean value indicating whether an agent has set the Busy state, for an agent or DN that is being monitored.
SC_OP_DESCRIPTION - A string describing the object that is being monitored.
SC_OP_TIMEINQUEUE - The number of seconds during which the call stayed in the ACD queue before it was answered.
SC_OP_QUEUEID - A string specifying the name of a queue. This is used together with SC_OP_ISLOGON to update the agent's login status for an ACD queue in the Communications view in the User Preferences screen.
SC_OP_ISLOGON - A value indicating that the agent logged on or logged off.

SCWorkItemMode

Identifies work item modes, for inbound or outbound work items.

NOTE:  In developing a driver, specify the names of the error codes, such as SC_WM_INBOUND, rather than the integer values.

enum SCWorkItemMode
{
      SC_WM_INBOUND  = 1,
      SC_WM_OUTBOUND = 2
};

Each work item type is described below:

SC_WM_INBOUND - The work item is an inbound item.
SC_WM_OUTBOUND - The work item is an outbound item, initiated by a user.

Bookshelf Home | Contents | Index | Search | PDF