1. CTI Administration Guide
  2. What’s New in This Release

11Siebel Communications Server Business Services

Siebel Communications Server Business Services

This chapter provides information about business services for Siebel Communications Server, including applicable business services, methods, and arguments. It includes the following topics:

About Business Services for Siebel Communications Server

The following are the business services of Siebel Communications Server. The names shown are the display names for these business services:

  • Communications Client. Supports the communications user interface features such as the communications toolbar and communications menu commands. This business service aggregates the Communications Session Manager business service. It does not deal with server-based communications functionality.

  • Communications Session Manager. Provides an interface to session-based communications functionality at the server level. Through Server Request Broker and Server Request Processor, this business service communicates with the Communications Session Manager server component. It does not deal with the communications user interface.

  • Outbound Communications Manager. Provides an interface to the outbound communications functionality of the Communications Outbound Manager server component. For more information about this business service, see Siebel Email Administration Guide.

For more information about integrating business services with Communications Server, see Using Business Services with Siebel Communications Server.

Communications Client Methods

This topic describes the methods and method arguments of the business service Communications Client. For more information about the role of business services and methods in communications toolbar configuration, see About Communications Panel and Communications Toolbar Configuration.

The Communications Client business service is an aggregate business service that is built on the Communications Session Manager service. This means that you can invoke all the methods of the Communications Session Manager service as though they were methods of the Communications Client business service.

This topic primarily uses the display names for each method (Method Display Name). The internal names, which must be used in any scripts that invoke these methods, are also shown (Method Name).

The following table lists the methods for the Communications Client business service.

Table Communications Client Methods

Method Display Name Method Name Comment

Agent Sign Off

AgentSignOff

Execute logout command

Agent Sign On

AgentSignOn

Execute login command

Get Selected Work Item Info

GetSelectedWorkItemInfo

Retrieve complete work item information of the selected work item on toolbar

Handle Error

HandleError

Push error information to the agent’s communications toolbar

Is Comm Enabled

IsCommEnabled

Indicates whether communications are enabled

Make Call

MakeCall

Make a phone call

Obtain UI Focus

ObtainUIFocus

Bring the browser to the front (to gain user interface focus)

Reset Active Session Count

ResetActiveSessionCount

Reset the active session count.

Send Communication

SendCommunication

Send outbound communication item

Shell UI Update

ShellUIUpdate

Update or refresh the status of the communications toolbar

Show Status Text

ShowStatusText

Push error information to the agent’s communications toolbar and display message on the browser’s status bar

Work Item Released

WorkItemReleased

Notification of work item released

Work Item Resumed

WorkItemResumed

Notification of work item resumed

Work Item Started

WorkItemStarted

Notification of work item started

Work Item Suspended

WorkItemSuspended

Notification of work item suspended

    Arguments for Communications Client Methods

    This topic lists the arguments for each method of the business service Communications Client. Each argument’s data type is also shown.

    Note: In Siebel Tools, other arguments than these might also be listed. Disregard any arguments that are flagged as Hidden or Inactive.

      Arguments for Agent Sign Off Method

      The Agent Sign Off method has no arguments.

        Arguments for Agent Sign On Method

        The Agent Sign On method has no arguments.

          Arguments for Get Selected Work Item Info Method

          The following table lists the arguments for the Get Selected Work Item Info method.

          Table Arguments for Get Selected Work Item Info Method

          Argument Display Name And Data Type Argument Name Type Req’d Comment

          Channel Type

          (type: String)

          ChannelType

          Output

          Yes

          The language-independent channel type

          Channel Type Locale

          (type: String)

          ChannelTypeLocale

          Output

          Yes

          The language-dependent channel type locale

          Description

          (type: String)

          Description

          Output

          Yes

          Work item description

          Driver Work Tracking ID

          (type: String)

          DriverWorkTrackID

          Output

          Yes

          The tracking ID of this work item in driver scope

          Icon File

          (type: String)

          IconFile

          Output

          Yes

          Icon file of the driver profile that owns this work item. The icon is also specified in the CSS file.

          Is Active State

          (type: Number)

          IsActiveState

          Output

          Yes

          Indicates if this work item is active

          Is Data Contained Inside

          (type: Number)

          HasWorkData

          Output

          Yes

          Indicates if this work item contains data inside

          Is Inbound Item

          (type: Number)

          IsInboundItem

          Output

          Yes

          Indicates if this is an inbound work item

          Parent Work Item ID

          (type: String)

          ParentWorkItemID

          Output

          Yes

          ID of parent work item

          Profile ID

          (type: String)

          ProfileID

          Output

          Yes

          ID of driver profile that owns this work item

          Profile Name

          (type: String)

          ProfileName

          Output

          Yes

          Name of driver profile that owns this work item

          Time In Queue

          (type: String)

          TimeInQueue

          Output

          Yes

          Time this work item stayed in the queue

          View Bookmark

          (type: String)

          ViewBookmark

          Output

          Yes

          View bookmark

          Work Duration

          (type: String)

          WorkDuration

          Output

          Yes

          Duration of work item

          Work Item ID

          (type: String)

          WorkItemID

          Input

          Yes

          Work item ID

          Work Item Key

          (type: String)

          WorkItemKey

          Output

          Yes

          Work item key

          Work Item Not Exist

          (type: Number)

          WorkItemNotExist

          Output

          Yes

          Work item does not exist

          Work Object ID

          (type: String)

          WorkObjectID

          Input

          Yes

          Object ID

          Work Start Time

          (type: String)

          WorkStartTime

          Output

          Yes

          Time work item started

          Work State

          (type: String)

          WorkState

          Output

          Yes

          Work item state

          Work Tracking Object Business Component

          (type: String)

          WorkTrackObjBusComp

          Output

          Yes

          Name of business component for after-work tracking

          Work Tracking Object Business Object

          (type: String)

          WorkTrackObjBusObj

          Output

          Yes

          Name of business object for after-work tracking

            Arguments for Handle Error Method

            The following table lists the arguments for the Handle Error method.

            Table Arguments for Handle Error Method

            Argument Display Name And Data Type Argument Name Type Req’d Comment

            Error

            (type: String)

            Error

            Input

            Yes

            Error text

              Arguments for Is Comm Enabled Method

              TThe following table lists the arguments for the Is Comm Enabled method.

              Table Arguments for Is Comm Enabled Method

              Argument Display Name And Data Type Argument Name Type Req’d Comment

              Is Comm Enabled

              (type: Number)

              IsCommEnabled

              Output

              Yes

              Indicates if the communications toolbar is enabled. 1 means True and 0 means False.

                Arguments for Make Call Method

                The following table lists the arguments for the Make Call method.

                Table Arguments for Make Call Method

                Argument Display Name And Data Type Argument Name Type Req’d Comment

                Apply Dialing Rule

                (type: Number)

                ApplyDialingRule

                Input

                No

                If dialing rule needs to be applied

                Phone Number

                (type: String)

                PhoneNumber

                Input

                Yes

                Phone number

                Profile Name

                (type: String)

                ProfileName

                Input

                Yes

                Name of driver profile

                  Arguments for Obtain UI Focus Method

                  The Obtain UI Focus method has no arguments.

                    Arguments for Send Communication Method

                    The following table lists the arguments for the Send Communication method.

                    Table Arguments for Send Communication Method

                    Argument Display Name And Data Type Argument Name Type Req’d Comment

                    Channel Type

                    (type: String)

                    CommType

                    Input

                    Yes

                    Supported values:

                    Wireless Email Fax Page

                    Method Argument

                    (type: String)

                    Method Argument

                    Input

                    Yes

                      Arguments for Shell UI Update Method

                      The Shell UI Update method has no arguments.

                        Arguments for Show Status Text Method

                        The following table lists the arguments for the Show Status Text method.

                        Table Arguments for Show Status Text Method

                        Argument Display Name And Data Type Argument Name Type Req’d Comment

                        Text

                        (type: String)

                        Text

                        Input

                        Yes

                        The text that is displayed at the browser’s status bar

                          Arguments for Work Item Released Method

                          The following table lists the arguments for the Work Item Released method.

                          Table Arguments for Work Item Released Method

                          Argument Display Name And Data Type Argument Name Type Req’d Comment

                          Stop Time

                          (type: Number)

                          StopTime

                          Input

                          Yes

                          Time that work item is released

                          Work Item ID

                          (type: String)

                          WorkItemID

                          Input

                          Yes

                          Work item ID

                            Arguments for Work Item Resumed Method

                            The following table lists the arguments for the Work Item Resumed method.

                            Table Arguments for Work Item Resumed Method

                            Argument Display Name And Data Type Argument Name Type Req’d Comment

                            Work Item ID

                            (type: String)

                            WorkItemID

                            Input

                            Yes

                            Work item ID

                              Arguments for Work Item Started Method

                              The following table lists the arguments for the Work Item Started method.

                              Table Arguments for Work Item Started Method

                              Argument Display Name And Data Type Argument Name Type Req’d Comment

                              Channel Profile

                              (type: String)

                              MediaProfile

                              Input

                              Yes

                              Name of driver profile that owns this work item

                              Channel Type

                              (type: String)

                              MediaType

                              Input

                              Yes

                              Language-independent value of the channel type

                              Description

                              (type: String)

                              Description

                              Input

                              Yes

                              Work item description

                              Object ID

                              (type: String)

                              ObjectID

                              Input

                              Yes

                              Object ID of work item

                              Old Work Item ID

                              (type: String)

                              OldWorkItemID

                              Input

                              Yes

                              Old work item ID

                              Start Time

                              (type: Number)

                              StartTime

                              Input

                              Yes

                              Time work item is started

                              Work Item ID

                              (type: String)

                              WorkItemID

                              Input

                              Yes

                              Work item ID

                                Arguments for Work Item Suspended Method

                                The following table lists the arguments for the Work Item Suspended method.

                                Table Arguments for Work Item Suspended Method

                                Argument Display Name And Data Type Argument Name Type Req’d Comment

                                Work Item ID

                                (type: String)

                                WorkItemID

                                Input

                                Yes

                                Work item ID

                                  Communications Session Manager Methods

                                  This topic describes the methods and method arguments of the business service Communications Session Manager.

                                  This topic primarily uses the display names for each method (Method Display Name). The internal names, which must be used in any scripts that invoke these methods, are also shown (Method Name).

                                  The following table lists the methods for the Communications Session Manager business service.

                                  Table Communications Session Manager Methods

                                  Method Display Name Method Name Comment

                                  Accept Work Item

                                  AcceptWorkItem

                                  Accept inbound work item

                                  Get Agent Extension

                                  GetAgentExtension

                                  Retrieve agent’s active extension number

                                  Get All Work Item ID

                                  GetAllWorkItemID

                                  Retrieve all work item IDs

                                  Get Inbound Work Item Attributes

                                  GetInboundWorkItemAttr

                                  Retrieve inbound work item attribute

                                  Get Inbound Work Item Info

                                  GetInboundWorkItemInfo

                                  Retrieve complete information of inbound work item

                                  Get Top Active Work Item ID

                                  GetTopActiveWorkItemID

                                  Retrieve the ID of most recent active work item

                                  Get Top Idle Work Item ID

                                  GetTopIdleWorkItemID

                                  Retrieve the ID of most recent idle work item

                                  Get Work Item Attributes

                                  GetWorkItemAttr

                                  Retrieve work item attributes

                                  Get Work Item Info

                                  GetWorkItemInfo

                                  Retrieve complete information of a work item

                                  Get Work Item Track Info

                                  GetWorkItemTrackInfo

                                  Retrieve the tracking info of work item

                                  Invoke Command

                                  InvokeCommand

                                  Invoke device command

                                  For more information, see related methods in Siebel Adaptive Communications API Reference.

                                  Invoke Extended Command

                                  InvokeCommandEx

                                  Invoke predefined device command

                                  For more information, see related methods in Siebel Adaptive Communications API Reference.

                                  Notify Event Handling Finished

                                  NotifyEventHandlingFinished

                                  Notify driver that event handling is over

                                  Release Work Item

                                  ReleaseWorkItem

                                  Release work item

                                  Release Work Item by Activity ID

                                  ReleaseWorkItemEx

                                  Release work item by activity record ID

                                  Resume Work Item

                                  ResumeWorkItem

                                  Resume work item

                                  Set Work Item Attributes

                                  SetWorkItemAttr

                                  Set work item attributes

                                  Suspend Work Item

                                  SuspendWorkItem

                                  Suspend work item

                                  Work Item Released

                                  WorkItemReleased

                                  Notification of work item released

                                  Work Item Resumed

                                  WorkItemResumed

                                  Notification of work item resumed

                                  Work Item Started

                                  WorkItemStarted

                                  Notification of work item started

                                  Work Item Suspended

                                  WorkItemSuspended

                                  Notification of work item suspended

                                    Arguments for Communications Session Manager Methods

                                    This topic lists the arguments for each method of the business service Communications Session Manager. Each argument’s data type is also shown.

                                    Note: In Siebel Tools, other arguments than these might also be listed. Disregard any arguments that are flagged as Hidden or Inactive.

                                      Arguments for Accept Work Item Method

                                      The following information lists the arguments for the Accept Work Item method.

                                      Table Arguments for Accept Work Item Method

                                      Argument Display Name And Data Type Argument Name Type Req’d Comment

                                      Work Item ID

                                      (type: String)

                                      WorkItemID

                                      Input

                                      Yes

                                      Work item ID
                                        Arguments for Get Agent Extension Method

                                        The following table lists the arguments for the Get Agent Extension method.

                                        Table Arguments for Get Agent Extension Method

                                        Argument Display Name And Data Type Argument Name Type Req’d Comment

                                        Agent Login

                                        (type: String)

                                        AgentLogin

                                        Input

                                        Yes

                                        Agent’s login name

                                        Destination DN

                                        (type: String)

                                        DestinationDN

                                        Output

                                        Yes

                                        Agent’s active extension
                                          Arguments for Get All Work Item ID Method

                                          TThe following table lists the arguments for the Get All Work Item ID method.

                                          Table Arguments for Get All Work Item ID Method

                                          Argument Display Name And Data Type Argument Name Type Req’d Comment

                                          ActiveWorkItem_N

                                          (type: String)

                                          ActiveWorkItem_N

                                          Output

                                          Yes

                                          Attribute names are in ActiveWorkItem_? format, such as ActiveWorkItem_0, ActiveWorkItem_1

                                          IdleWorkItem_N

                                          (type: String)

                                          IdleWorkItem_N

                                          Output

                                          Yes

                                          Attribute names are in IdleWorkItem_? format, such as IdleWorkItem_0, IdleWorkItem_1
                                            Arguments for Get Inbound Work Item Attributes Method

                                            The following table lists the arguments for the Get Inbound Work Item Attributes method.

                                            Note: The Attribute Name and Attribute Value arguments are available for use, though they are not listed in Siebel Tools as arguments for this method.

                                            Table Arguments for Get Inbound Work Item Attributes Method

                                            Argument Display Name And Data Type Argument Name Type Req’d Comment

                                            Attribute Name

                                            (type: String)

                                            AttrName

                                            Input

                                            No

                                            Name of the attribute

                                            Attribute Value

                                            (type: String)

                                            AttrValue

                                            Output

                                            No

                                            Value for the attribute

                                            Channel Type

                                            (type: String)

                                            ChannelType

                                            Input

                                            Yes

                                            Name of language-independent channel type

                                            Item Index

                                            (type: Number)

                                            ItemIndex

                                            Input

                                            Yes

                                            Index of inbound work item
                                              Arguments for Get Inbound Work Item Info Method

                                              The following table lists the arguments for the Get Inbound Work Item Info method.

                                              Table Arguments for Get Inbound Work Item Info Method

                                              Argument Display Name And Data Type Argument Name Type Req’d Comment

                                              Channel Type

                                              (type: String)

                                              ChannelType

                                              Input

                                              Yes

                                              The language-independent channel type

                                              Channel Type Locale

                                              (type: String)

                                              MediaTypeLocale

                                              Output

                                              Yes

                                              The language-dependent channel type locale

                                              Description

                                              (type: String)

                                              Description

                                              Output

                                              Yes

                                              Work item description

                                              Driver Work Tracking ID

                                              (type: String)

                                              DriverWorkTrackID

                                              Output

                                              Yes

                                              Work tracking ID in driver scope

                                              Icon File

                                              (type: String)

                                              IconFile

                                              Output

                                              Yes

                                              Icon file of the driver profile that owns this work item. The icon is also specified in the CSS file.

                                              Is Active State

                                              (type: Number)

                                              IsActiveState

                                              Output

                                              Yes

                                              Indicates if this work item is active

                                              Is Data Contained Inside

                                              (type: Number)

                                              HasWorkData

                                              Output

                                              No

                                              Indicates if this work item contains data inside

                                              Is Inbound Item

                                              (type: Number)

                                              IsInboundItem

                                              Output

                                              Yes

                                              Indicates if this is an inbound work item

                                              Item Index

                                              (type: Number)

                                              ItemIndex

                                              Input

                                              Yes

                                              The index of work item

                                              Parent Work Item ID

                                              (type: String)

                                              ParentWorkItemID

                                              Output

                                              Yes

                                              ID of parent work item

                                              Profile ID

                                              (type: String)

                                              ProfileID

                                              Output

                                              Yes

                                              Row ID of driver profile

                                              Profile Name

                                              (type: String)

                                              ProfileName

                                              Output

                                              Yes

                                              Name of driver profile

                                              Time In Queue

                                              (type: Number)

                                              TimeInQueue

                                              Output

                                              Yes

                                              Time work item in queue

                                              View Bookmark

                                              (type: String)

                                              ViewBookmark

                                              Output

                                              Yes

                                              View bookmark

                                              Work Duration

                                              (type: String)

                                              WorkDuration

                                              Output

                                              Yes

                                              Duration of work item

                                              Work Item ID

                                              (type: String)

                                              WorkItemID

                                              Output

                                              Yes

                                              Work item ID

                                              Work Item Not Exist

                                              (type: Number)

                                              WorkItemNotExist

                                              Output

                                              Yes

                                              If such work item exists

                                              Work Object ID

                                              (type: String)

                                              WorkObjectID

                                              Output

                                              Yes

                                              Work object ID

                                              Work Start Time

                                              (type: String)

                                              WorkStartTime

                                              Output

                                              Yes

                                              Time work item started

                                              Work State

                                              (type: String)

                                              WorkState

                                              Output

                                              Yes

                                              Work item state

                                              Work Tracking Object Business Component

                                              (type: String)

                                              WorkTrackObjBusComp

                                              Output

                                              Yes

                                              Name of business component for after-work tracking

                                              Work Tracking Object Business Object

                                              (type: String)

                                              WorkTrackObjBusObj

                                              Output

                                              Yes

                                              Name of business object for after-work tracking
                                                Arguments for Get Top Active Work Item ID Method

                                                The following table lists the arguments for the Get Top Active Work Item ID method.

                                                Table Arguments for Get Top Active Work Item ID Method

                                                Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                Work Item ID

                                                (type: String)

                                                WorkItemID

                                                Output

                                                No

                                                Work item ID
                                                  Arguments for Get Top Idle Work Item ID Method

                                                  The following table lists the arguments for the Get Top Idle Work Item ID method.

                                                  Table Arguments for Get Top Idle Work Item ID Method

                                                  Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                  Work Item ID

                                                  (type: String)

                                                  WorkItemID

                                                  Output

                                                  No

                                                  Work item ID
                                                    Arguments for Get Work Item Attributes Method

                                                    The following information lists the arguments for the Get Work Item Attributes method.

                                                    Note: The Attribute Name and Attribute Value arguments are available for use, though they are not listed in Siebel Tools as arguments for this method.

                                                    Table Arguments for Get Work Item Attributes Method

                                                    Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                    Attribute Name

                                                    (type: String)

                                                    AttrName

                                                    Input

                                                    No

                                                    Name of the attribute

                                                    Attribute Value

                                                    (type: String)

                                                    AttrValue

                                                    Output

                                                    No

                                                    Value for the attribute

                                                    Work Item ID

                                                    (type: String)

                                                    WorkItemID

                                                    Input

                                                    Yes

                                                    Work item ID
                                                      Arguments for Get Work Item Info Method

                                                      The following table lists the arguments for the Get Work Item Info method.

                                                      Table Arguments for Get Work Item Info Method

                                                      Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                      Channel Type

                                                      (type: String)

                                                      MediaType

                                                      Output

                                                      Yes

                                                      The language-independent channel type

                                                      Channel Type Locale

                                                      (type: String)

                                                      MediaTypeLocale

                                                      Output

                                                      Yes

                                                      The language-dependent channel type locale

                                                      Description

                                                      (type: String)

                                                      Description

                                                      Output

                                                      Yes

                                                      Work item description

                                                      Driver Work Tracking ID

                                                      (type: String)

                                                      DriverWorkTrackID

                                                      Output

                                                      Yes

                                                      The tracking ID of this work item in driver scope

                                                      Icon File

                                                      (type: String)

                                                      IconFile

                                                      Output

                                                      Yes

                                                      Icon file of the driver profile that owns this work item. The icon is also specified in the CSS file.

                                                      Is Active State

                                                      (type: String)

                                                      IsActiveState

                                                      Output

                                                      Yes

                                                      Indicates if this work item is active

                                                      Is Data Contained Inside

                                                      (type: Number)

                                                      HasWorkData

                                                      Output

                                                      No

                                                      Indicates if this work item contains data inside

                                                      Is Inbound Item

                                                      (type: String)

                                                      IsInboundItem

                                                      Output

                                                      Yes

                                                      Indicates if this is an inbound work item

                                                      Parent Work Item ID

                                                      (type: String)

                                                      ParentWorkItemID

                                                      Output

                                                      Yes

                                                      ID of parent work item

                                                      Profile ID

                                                      (type: String)

                                                      ProfileID

                                                      Output

                                                      Yes

                                                      ID of driver profile that owns this work item

                                                      Profile Name

                                                      (type: String)

                                                      ProfileName

                                                      Output

                                                      Yes

                                                      Name of driver profile which owns this work item

                                                      Time In Queue

                                                      (type: String)

                                                      TimeInQueue

                                                      Output

                                                      Yes

                                                      Time this work item stays in the queue

                                                      View Bookmark

                                                      (type: String)

                                                      ViewBookmark

                                                      Output

                                                      Yes

                                                      View bookmark

                                                      Work Duration

                                                      (type: String)

                                                      WorkDuration

                                                      Output

                                                      Yes

                                                      Duration of work item

                                                      Work Item ID

                                                      (type: String)

                                                      WorkItemID

                                                      Input

                                                      Yes

                                                      Work item ID

                                                      Work Item Key

                                                      (type: String)

                                                      WorkItemKey

                                                      Output

                                                      Yes

                                                      Work item key

                                                      Work Item Not Exist

                                                      (type: Number)

                                                      WorkItemNotExist

                                                      Output

                                                      No

                                                      Work item does not exist

                                                      Work Object ID

                                                      (type: String)

                                                      WorkObjectID

                                                      Output

                                                      Yes

                                                      Object ID

                                                      Work Start Time

                                                      (type: String)

                                                      WorkStartTime

                                                      Output

                                                      Yes

                                                      Time work item started

                                                      Work State

                                                      (type: String)

                                                      WorkState

                                                      Output

                                                      Yes

                                                      Work item state

                                                      Work Tracking Object Business Component

                                                      (type: String)

                                                      WorkTrackObjBusComp

                                                      Output

                                                      Yes

                                                      Name of business component for after-work tracking

                                                      Work Tracking Object Business Object

                                                      (type: String)

                                                      WorkTrackObjBusObj

                                                      Output

                                                      Yes

                                                      Name of business object for after-work tracking
                                                        Arguments for Get Work Item Track Info Method

                                                        The following table lists the arguments for the Get Work Item Track Info method.

                                                        Table Arguments for Get Work Item Track Info Method

                                                        Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                        After Work Tracking Object Business Component

                                                        (type: String)

                                                        AfcBusComp

                                                        Output

                                                        Yes

                                                        Name of business component for after-work tracking

                                                        After Work Tracking Object Business Object

                                                        (type: String)

                                                        AfcBusObj

                                                        Output

                                                        Yes

                                                        Name of business object for after-work tracking

                                                        After Work Tracking Object Row ID

                                                        (type: String)

                                                        AfcRowID

                                                        Output

                                                        Yes

                                                        Record ID for after-work tracking

                                                        Work Item ID

                                                        (type: String)

                                                        WorkItemID

                                                        Input

                                                        Yes

                                                        Work item ID
                                                          Arguments for Invoke Command Method

                                                          The following table lists the arguments for the Invoke Command method.

                                                          Table Arguments for Invoke Command Method

                                                          Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                          Command Tracking ID

                                                          (type: String)

                                                          CommandTrackingID

                                                          Input

                                                          Yes

                                                          Command ID

                                                          Data Set

                                                          (type: Hierarchy)

                                                          DataSet

                                                          Input

                                                          Yes

                                                          Data parameters for driver

                                                          Device Command

                                                          (type: String)

                                                          DeviceCommand

                                                          Input

                                                          Yes

                                                          Command to be invoked in driver

                                                          Driver Profile ID

                                                          (type: String)

                                                          DriverProfileID

                                                          Input

                                                          Yes

                                                          Row ID of driver profile which is invoked

                                                          Profile Name

                                                          (type: String)

                                                          ProfileName

                                                          Input

                                                          Yes

                                                          Name of driver profile which is invoked

                                                          String Parameter

                                                          (type: String)

                                                          StringParam

                                                          Input

                                                          Yes

                                                          Single string data
                                                            Arguments for Invoke Extended Command Method

                                                            The following table lists the arguments for the Invoke Extended Command method.

                                                            Table Arguments for Invoke Extended Command Method

                                                            Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                            Command Tracking ID

                                                            (type: String)

                                                            CommandTrackingID

                                                            Input

                                                            Yes

                                                            Command ID

                                                            Command Type

                                                            (type: Number)

                                                            CommandType

                                                            Input

                                                            Yes

                                                            Command type

                                                            Data Set

                                                            (type: Hierarchy)

                                                            DataSet

                                                            Input

                                                            Yes

                                                            Data parameters for driver

                                                            Driver Profile ID

                                                            (type: String)

                                                            DriverProfileID

                                                            Input

                                                            Yes

                                                            Row ID of driver profile which is invoked

                                                            Profile Name

                                                            (type: String)

                                                            ProfileName

                                                            Input

                                                            Yes

                                                            Name of driver profile which is invoked
                                                              Arguments for Notify Event Handling Finished Method

                                                              The following table lists the arguments for the Notify Event Handling Finished method.

                                                              Table Arguments for Notify Event Handling Finished Method

                                                              Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                              Result

                                                              (type: Number)

                                                              Result

                                                              Input

                                                              Yes

                                                              Result code

                                                              Work Item ID

                                                              (type: String)

                                                              WorkItemID

                                                              Input

                                                              Yes

                                                              Work item ID
                                                                Arguments for Release Work Item Method

                                                                The following table lists the arguments for the Release Work Item method.

                                                                Table Arguments for Release Work Item Method

                                                                Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                Work Item ID

                                                                (type: String)

                                                                WorkItemID

                                                                Input

                                                                Yes

                                                                Work item ID
                                                                  Arguments for Release Work Item by Activity ID Method

                                                                  The following table lists the arguments for the Release Work Item by Activity ID method.

                                                                  Table Arguments for Release Work Item By Activity ID Method

                                                                  Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                  Activity ID

                                                                  (type: String)

                                                                  ActivityID

                                                                  Input

                                                                  Yes

                                                                  Row ID of activity record
                                                                    Arguments for Resume Work Item Method

                                                                    The following table lists the arguments for the Resume Work Item method.

                                                                    Table Arguments for Resume Work Item Method

                                                                    Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                    Work Item ID

                                                                    (type: String)

                                                                    WorkItemID

                                                                    Input

                                                                    Yes

                                                                    Work item ID
                                                                      Arguments for Set Work Item Attributes Method

                                                                      The following information lists the arguments for the Set Work Item Attributes method.

                                                                      Note: For this method, you can set values for one or more attributes for the work item, using key-value pairs rather than arguments with fixed names. (By contrast, the methods Get Inbound Work Item Attributes and Get Work Item Attributes use the Attribute Name and Attribute Value arguments to store the name of a single attribute to retrieve, and its value, respectively.)

                                                                      Table Arguments for Set Work Item Attributes Method

                                                                      Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                      Work Item ID

                                                                      (type: String)

                                                                      WorkItemID

                                                                      Input

                                                                      Yes

                                                                      Work item ID
                                                                        Arguments for Suspend Work Item Method

                                                                        The following table lists the arguments for the Suspend Work Item method.

                                                                        Table Arguments for Suspend Work Item Method

                                                                        Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                        Work Item ID

                                                                        (type: String)

                                                                        WorkItemID

                                                                        Input

                                                                        Yes

                                                                        Work item ID
                                                                          Arguments for Work Item Released Method

                                                                          The following table lists the arguments for the Work Item Released method.

                                                                          Table Arguments for Work Item Released Method

                                                                          Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                          Stop Time

                                                                          (type: Number)

                                                                          StopTime

                                                                          Input

                                                                          Yes

                                                                          Time that work item is released

                                                                          Work Item ID

                                                                          (type: String)

                                                                          WorkItemID

                                                                          Input

                                                                          Yes

                                                                          Work item ID
                                                                            Arguments for Work Item Resumed Method

                                                                            The following table lists the arguments for the Work Item Resumed method.

                                                                            Table Arguments for Work Item Resumed Method

                                                                            Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                            Work Item ID

                                                                            (type: String)

                                                                            WorkItemID

                                                                            Input

                                                                            Yes

                                                                            Work item ID
                                                                              Arguments for Work Item Started Method

                                                                              The following table lists the arguments for the Work Item Started method.

                                                                              Table Arguments for Work Item Started Method

                                                                              Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                              Channel Profile

                                                                              (type: Number)

                                                                              MediaProfile

                                                                              Input

                                                                              Yes

                                                                              Name of driver profile that owns this work item

                                                                              Channel Type

                                                                              (type: Number)

                                                                              MediaType

                                                                              Input

                                                                              Yes

                                                                              Language-independent value of channel string

                                                                              Description

                                                                              (type: String)

                                                                              Description

                                                                              Input

                                                                              Yes

                                                                              Work item description

                                                                              Object ID

                                                                              (type: String)

                                                                              ObjectID

                                                                              Input

                                                                              Yes

                                                                              Object ID of work item

                                                                              Old Work Item ID

                                                                              (type: String)

                                                                              OldWorkItemID

                                                                              Input

                                                                              Yes

                                                                              Old work item ID

                                                                              Start Time

                                                                              (type: Number)

                                                                              StartTime

                                                                              Input

                                                                              Yes

                                                                              Time work item is started

                                                                              Work Item ID

                                                                              (type: String)

                                                                              WorkItemID

                                                                              Input

                                                                              Yes

                                                                              Work item ID
                                                                                Arguments for Work Item Suspended Method

                                                                                The following table lists the arguments for the Work Item Suspended method.

                                                                                Table Arguments for Work Item Suspended Method

                                                                                Argument Display Name And Data Type Argument Name Type Req’d Comment

                                                                                Work Item ID

                                                                                (type: String)

                                                                                WorkItemID

                                                                                Input

                                                                                Yes

                                                                                Work item ID