|
Siebel CTI Administration Guide > Siebel Communications Server Business Services > Communications Session Manager Methods >
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
Table 73 lists the arguments for the Accept Work Item method.
Table 73. Arguments for Accept Work Item Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Get Agent Extension Method
Table 74 lists the arguments for the Get Agent Extension method.
Table 74. Arguments for Get Agent Extension Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 75 lists the arguments for the Get All Work Item ID method.
Table 75. Arguments for Get All Work Item ID Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 76 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 76. Arguments for Get Inbound Work Item Attributes Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 77 lists the arguments for the Get Inbound Work Item Info method.
Table 77. Arguments for Get Inbound Work Item Info Method
Argument Display Name And Data Type |
|
|
|
|
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 driver profile that owns this work item |
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
Table 78 lists the arguments for the Get Top Active Work Item ID method.
Table 78. Arguments for Get Top Active Work Item ID Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Output |
No |
Work item ID |
Arguments for Get Top Idle Work Item ID Method
Table 79 lists the arguments for the Get Top Idle Work Item ID method.
Table 79. Arguments for Get Top Idle Work Item ID Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Output |
No |
Work item ID |
Arguments for Get Work Item Attributes Method
Table 80 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 80. Arguments for Get Work Item Attributes Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 81 lists the arguments for the Get Work Item Info method.
Table 81. Arguments for Get Work Item Info Method
Argument Display Name And Data Type |
|
|
|
|
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 driver profile that owns this work item |
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
Table 82 lists the arguments for the Get Work Item Track Info method.
Table 82. Arguments for Get Work Item Track Info Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 83 lists the arguments for the Invoke Command method.
Table 83. Arguments for Invoke Command Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 84 lists the arguments for the Invoke Extended Command method.
Table 84. Arguments for Invoke Extended Command Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 85 lists the arguments for the Notify Event Handling Finished method.
Table 85. Arguments for Notify Event Handling Finished Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 86 lists the arguments for the Release Work Item method.
Table 86. Arguments for Release Work Item Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Release Work Item by Activity ID Method
Table 87 lists the arguments for the Release Work Item by Activity ID method.
Table 87. Arguments for Release Work Item By Activity ID Method
Argument Display Name And Data Type |
|
|
|
|
Activity ID (type: String) |
ActivityID |
Input |
Yes |
Row ID of activity record |
Arguments for Resume Work Item Method
Table 88 lists the arguments for the Resume Work Item method.
Table 88. Arguments for Resume Work Item Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Set Work Item Attributes Method
Table 89 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 89. Arguments for Set Work Item Attributes Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Suspend Work Item Method
Table 90 lists the arguments for the Suspend Work Item method.
Table 90. Arguments for Suspend Work Item Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Work Item Released Method
Table 91 lists the arguments for the Work Item Released method.
Table 91. Arguments for Work Item Released Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 92 lists the arguments for the Work Item Resumed method.
Table 92. Arguments for Work Item Resumed Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
Arguments for Work Item Started Method
Table 93 lists the arguments for the Work Item Started method.
Table 93. Arguments for Work Item Started Method
Argument Display Name And Data Type |
|
|
|
|
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
Table 94 lists the arguments for the Work Item Suspended method.
Table 94. Arguments for Work Item Suspended Method
Argument Display Name And Data Type |
|
|
|
|
Work Item ID (type: String) |
WorkItemID |
Input |
Yes |
Work item ID |
| 
