Siebel Communications Server Administration Guide > Communications Server Business Services > Communications Session Manager Methods >
Arguments for Communications Session Manager Methods
This section 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 may also be listed. Disregard any arguments that are flagged as Hidden or Inactive.
Arguments for Accept Work Item Method
Table 99 lists the arguments for the Accept Work Item method.
Table 99. Arguments for Accept Work Item Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Get Agent Extension Method
Table 100 lists the arguments for the Get Agent Extension method.
Table 100. Arguments for Get Agent Extension Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Agent Login
(type: String)
|
AgentLogin
|
Input
|
Y
|
Agent's login name
|
Destination DN
(type: String)
|
DestinationDN
|
Output
|
Y
|
Agent's active extension
|
Arguments for Get All Work Item ID Method
Table 101 lists the arguments for the Get All Work Item ID method.
Table 101. Arguments for Get All Work Item ID Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
ActiveWorkItem_N
(type: String)
|
ActiveWorkItem_N
|
Output
|
Y
|
Attribute names are in ActiveWorkItem_? format, such as ActiveWorkItem_0, ActiveWorkItem_1
|
IdleWorkItem_N
(type: String)
|
IdleWorkItem_N
|
Output
|
Y
|
Attribute names are in IdleWorkItem_? format, such as IdleWorkItem_0, IdleWorkItem_1
|
Arguments for Get Inbound Work Item Attributes Method
Table 102 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 102. Arguments for Get Inbound Work Item Attributes Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Attribute Name
(type: String)
|
AttrName
|
Input
|
N
|
Name of the attribute
|
Attribute Value
(type: String)
|
AttrValue
|
Output
|
N
|
Value for the attribute
|
Channel Type
(type: String)
|
ChannelType
|
Input
|
Y
|
Name of language-independent channel type
|
Item Index
(type: Number)
|
ItemIndex
|
Input
|
Y
|
Index of inbound work item
|
Arguments for Get Inbound Work Item Info Method
Table 103 lists the arguments for the Get Inbound Work Item Info method.
Table 103. Arguments for Get Inbound Work Item Info Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Type
(type: String)
|
ChannelType
|
Input
|
Y
|
The language-independent channel type
|
Channel Type Locale
(type: String)
|
MediaTypeLocale
|
Output
|
Y
|
The language-dependent channel type locale
|
Description
(type: String)
|
Description
|
Output
|
Y
|
Work item description
|
Driver Work Tracking ID
(type: String)
|
DriverWorkTrackID
|
Output
|
Y
|
Work tracking ID in driver scope
|
Icon File
(type: String)
|
IconFile
|
Output
|
Y
|
Icon file of driver profile that owns this work item
|
Is Active State
(type: Number)
|
IsActiveState
|
Output
|
Y
|
Is work item active?
|
Is Data Contained Inside
(type: Number)
|
HasWorkData
|
Output
|
N
|
Is data contained inside?
|
Is Inbound Item
(type: Number)
|
IsInboundItem
|
Output
|
Y
|
Is inbound work item?
|
Item Index
(type: Number)
|
ItemIndex
|
Input
|
Y
|
The index of work item
|
Parent Work Item ID
(type: String)
|
ParentWorkItemID
|
Output
|
Y
|
ID of parent work item
|
Profile ID
(type: String)
|
ProfileID
|
Output
|
Y
|
Row ID of driver profile
|
Profile Name
(type: String)
|
ProfileName
|
Output
|
Y
|
Name of driver profile
|
Time In Queue
(type: Number)
|
TimeInQueue
|
Output
|
Y
|
Time work item in queue
|
UQ Work Item ID
(type: String)
|
UQWorkItemID
|
Output
|
Y
|
The original work item when received from UQ
|
View Bookmark
(type: String)
|
ViewBookmark
|
Output
|
Y
|
View bookmark
|
Work Duration
(type: String)
|
WorkDuration
|
Output
|
Y
|
Duration of work item
|
Work Item ID
(type: String)
|
WorkItemID
|
Output
|
Y
|
Work item ID
|
Work Item Not Exist
(type: Number)
|
WorkItemNotExist
|
Output
|
Y
|
If such work item exists
|
Work Object ID
(type: String)
|
WorkObjectID
|
Output
|
Y
|
Work object ID
|
Work Start Time
(type: String)
|
WorkStartTime
|
Output
|
Y
|
Time work item started
|
Work State
(type: String)
|
WorkState
|
Output
|
Y
|
Work item state
|
Work Tracking Object Business Component
(type: String)
|
WorkTrackObjBusComp
|
Output
|
Y
|
Name of business component for after-work tracking
|
Work Tracking Object Business Object
(type: String)
|
WorkTrackObjBusObj
|
Output
|
Y
|
Name of business object for after-work tracking
|
Arguments for Get Top Active Work Item ID Method
Table 104 lists the arguments for the Get Top Active Work Item ID method.
Table 104. Arguments for Get Top Active Work Item ID Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Output
|
N
|
Work item ID
|
Arguments for Get Top Idle Work Item ID Method
Table 105 lists the arguments for the Get Top Idle Work Item ID method.
Table 105. Arguments for Get Top Idle Work Item ID Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Output
|
N
|
Work item ID
|
Arguments for Get Work Item Attributes Method
Table 106 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 106. Arguments for Get Work Item Attributes Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Attribute Name
(type: String)
|
AttrName
|
Input
|
N
|
Name of the attribute
|
Attribute Value
(type: String)
|
AttrValue
|
Output
|
N
|
Value for the attribute
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Get Work Item Info Method
Table 107 lists the arguments for the Get Work Item Info method.
Table 107. Arguments for Get Work Item Info Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Type
(type: String)
|
MediaType
|
Output
|
Y
|
The language-independent channel type
|
Channel Type Locale
(type: String)
|
MediaTypeLocale
|
Output
|
Y
|
The language-dependent channel type locale
|
Description
(type: String)
|
Description
|
Output
|
Y
|
Work item description
|
Driver Work Tracking ID
(type: String)
|
DriverWorkTrackID
|
Output
|
Y
|
The tracking ID of this work item in driver scope
|
Icon File
(type: String)
|
IconFile
|
Output
|
Y
|
Icon file of driver profile that owns this work item
|
Is Active State
(type: String)
|
IsActiveState
|
Output
|
Y
|
Is this work item active?
|
Is Data Contained Inside
(type: Number)
|
HasWorkData
|
Output
|
N
|
Is data contained inside?
|
Is Inbound Item
(type: String)
|
IsInboundItem
|
Output
|
Y
|
Is this work item inbound work item?
|
Parent Work Item ID
(type: String)
|
ParentWorkItemID
|
Output
|
Y
|
ID of parent work item
|
Profile ID
(type: String)
|
ProfileID
|
Output
|
Y
|
ID of driver profile that owns this work item
|
Profile Name
(type: String)
|
ProfileName
|
Output
|
Y
|
Name of driver profile which owns this work item
|
Time In Queue
(type: String)
|
TimeInQueue
|
Output
|
Y
|
Time this work item stays in the queue
|
UQ Work Item ID
(type: String)
|
UQWorkItemID
|
Output
|
Y
|
The original work item ID when received from UQ
|
View Bookmark
(type: String)
|
ViewBookmark
|
Output
|
Y
|
View bookmark
|
Work Duration
(type: String)
|
WorkDuration
|
Output
|
Y
|
Duration of work item
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Work Item Key
(type: String)
|
WorkItemKey
|
Output
|
Y
|
Work item key
|
Work Item Not Exist
(type: Number)
|
WorkItemNotExist
|
Output
|
N
|
Work item does not exist
|
Work Object ID
(type: String)
|
WorkObjectID
|
Output
|
Y
|
Object ID
|
Work Start Time
(type: String)
|
WorkStartTime
|
Output
|
Y
|
Time work item started
|
Work State
(type: String)
|
WorkState
|
Output
|
Y
|
Work item state
|
Work Tracking Object Business Component
(type: String)
|
WorkTrackObjBusComp
|
Output
|
Y
|
Name of business component for after-work tracking
|
Work Tracking Object Business Object
(type: String)
|
WorkTrackObjBusObj
|
Output
|
Y
|
Name of business object for after-work tracking
|
Arguments for Get Work Item Track Info Method
Table 108 lists the arguments for the Get Work Item Track Info method.
Table 108. Arguments for Get Work Item Track Info Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
After Work Tracking Object Business Component
(type: String)
|
AfcBusComp
|
Output
|
Y
|
Name of business component for after-work tracking
|
After Work Tracking Object Business Object
(type: String)
|
AfcBusObj
|
Output
|
Y
|
Name of business object for after-work tracking
|
After Work Tracking Object Row ID
(type: String)
|
AfcRowID
|
Output
|
Y
|
Record ID for after-work tracking
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Invoke Command Method
Table 109 lists the arguments for the Invoke Command method.
Table 109. Arguments for Invoke Command Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Command Tracking ID
(type: String)
|
CommandTrackingID
|
Input
|
Y
|
Command ID
|
Data Set
(type: Hierarchy)
|
DataSet
|
Input
|
Y
|
Data parameters for driver
|
Device Command
(type: String)
|
DeviceCommand
|
Input
|
Y
|
Command to be invoked in driver
|
Driver Profile ID
(type: String)
|
DriverProfileID
|
Input
|
Y
|
Row ID of driver profile which will be invoked
|
Profile Name
(type: String)
|
ProfileName
|
Input
|
Y
|
Name of driver profile which will be invoked
|
String Parameter
(type: String)
|
StringParam
|
Input
|
Y
|
Single string data
|
Arguments for Invoke Extended Command Method
Table 110 lists the arguments for the Invoke Extended Command method.
Table 110. Arguments for Invoke Extended Command Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Command Tracking ID
(type: String)
|
CommandTrackingID
|
Input
|
Y
|
Command ID
|
Command Type
(type: Number)
|
CommandType
|
Input
|
Y
|
Command type
|
Data Set
(type: Hierarchy)
|
DataSet
|
Input
|
Y
|
Data parameters for driver
|
Driver Profile ID
(type: String)
|
DriverProfileID
|
Input
|
Y
|
Row ID of driver profile which will be invoked
|
Profile Name
(type: String)
|
ProfileName
|
Input
|
Y
|
Name of driver profile which will be invoked
|
Arguments for Notify Event Handling Finished Method
Table 111 lists the arguments for the Notify Event Handling Finished method.
Table 111. Arguments for Notify Event Handling Finished Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Result
(type: Number)
|
Result
|
Input
|
Y
|
Result code
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Release Work Item Method
Table 112 lists the arguments for the Release Work Item method.
Table 112. Arguments for Release Work Item Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Release Work Item by Activity ID Method
Table 113 lists the arguments for the Release Work Item by Activity ID method.
Table 113. Arguments for Release Work Item By Activity ID Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Activity ID
(type: String)
|
ActivityID
|
Input
|
Y
|
Row ID of activity record
|
Arguments for Resume Work Item Method
Table 114 lists the arguments for the Resume Work Item method.
Table 114. Arguments for Resume Work Item Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Set Work Item Attributes Method
Table 115 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 115. Arguments for Set Work Item Attributes Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Suspend Work Item Method
Table 116 lists the arguments for the Suspend Work Item method.
Table 116. Arguments for Suspend Work Item Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Work Item Released Method
Table 117 lists the arguments for the Work Item Released method.
Table 117. Arguments for Work Item Released Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Stop Time
(type: Number)
|
StopTime
|
Input
|
Y
|
Time that work item is released
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Work Item Resumed Method
Table 118 lists the arguments for the Work Item Resumed method.
Table 118. Arguments for Work Item Resumed Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Work Item Started Method
Table 119 lists the arguments for the Work Item Started method.
Table 119. Arguments for Work Item Started Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Profile
(type: Number)
|
MediaProfile
|
Input
|
Y
|
Name of driver profile that owns this work item
|
Channel Type
(type: Number)
|
MediaType
|
Input
|
Y
|
Language-independent value of channel string
|
Description
(type: String)
|
Description
|
Input
|
Y
|
Work item description
|
Object ID
(type: String)
|
ObjectID
|
Input
|
Y
|
Object ID of work item
|
Old Work Item ID
(type: String)
|
OldWorkItemID
|
Input
|
Y
|
Old work item ID
|
Start Time
(type: Number)
|
StartTime
|
Input
|
Y
|
Time work item is started
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
Arguments for Work Item Suspended Method
Table 120 lists the arguments for the Work Item Suspended method.
Table 120. Arguments for Work Item Suspended Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Work Item ID
(type: String)
|
WorkItemID
|
Input
|
Y
|
Work item ID
|
