Siebel Communications Server Administration Guide > Communications Server Business Services > Communications Client Methods >
Arguments for Communications Client Methods
This section 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 may 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
Table 87 lists the arguments for the Get Selected Work Item Info method.
Table 87. Arguments for Get Selected Work Item Info Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Type
(type: String)
|
ChannelType
|
Output
|
Y
|
The language-independent channel type
|
Channel Type Locale
(type: String)
|
ChannelTypeLocale
|
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 the driver profile that owns this work item
|
Is Active State
(type: Number)
|
IsActiveState
|
Output
|
Y
|
Is this work item active?
|
Is Data Contained Inside
(type: Number)
|
HasWorkData
|
Output
|
Y
|
Is data contained inside?
|
Is Inbound Item
(type: Number)
|
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 that owns this work item
|
Time In Queue
(type: String)
|
TimeInQueue
|
Output
|
Y
|
Time this work item stayed 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
|
Y
|
Work item does not exist
|
Work Object ID
(type: String)
|
WorkObjectID
|
Input
|
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 Handle Error Method
Table 88 lists the arguments for the Handle Error method.
Table 88. Arguments for Handle Error Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Error
(type: String)
|
Error
|
Input
|
Y
|
Error text
|
Arguments for Is Comm Enabled Method
Table 89 lists the arguments for the Is Comm Enabled method.
Table 89. Arguments for Is Comm Enabled Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Is Comm Enabled
(type: Number)
|
IsCommEnabled
|
Output
|
Y
|
Indicate if communications toolbar is enabled. 1 means TRUE and 0 means FALSE.
|
Arguments for Is Comm Simulated Method
Table 90 lists the arguments for the Is Comm Simulated method.
Table 90. Arguments for Is Comm Simulated Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Is Comm Simulated
(type: Number)
|
IsCommSimulated
|
Output
|
Y
|
Indicate if communications toolbar is in simulation mode. 1 means TRUE and 0 means FALSE.
|
Arguments for Make Call Method
Table 91 lists the arguments for the Make Call method.
Table 91. Arguments for Make Call Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Apply Dialing Rule
(type: Number)
|
ApplyDialingRule
|
Input
|
N
|
If dialing rule needs to be applied
|
Phone Number
(type: String)
|
PhoneNumber
|
Input
|
Y
|
Phone number
|
Profile Name
(type: String)
|
ProfileName
|
Input
|
Y
|
Name of driver profile
|
Arguments for Obtain UI Focus Method
The Obtain UI Focus method has no arguments.
Arguments for Send Communication Method
Table 92 lists the arguments for the Send Communication method.
Table 92. Arguments for Send Communication Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Type
(type: String)
|
CommType
|
Input
|
Y
|
Supported values:
Email
Fax
Page
Wireless
|
Method Argument
(type: String)
|
Method Argument
|
Input
|
Y
|
|
Arguments for Shell UI Update Method
The Shell UI Update method has no arguments.
Arguments for Show Status Text Method
Table 93 lists the arguments for the Show Status Text method.
Table 93. Arguments for Show Status Text Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Text
(type: String)
|
Text
|
Input
|
Y
|
The text that will be displayed at the browser's status bar
|
Arguments for Work Item Released Method
Table 94 lists the arguments for the Work Item Released method.
Table 94. 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 95 lists the arguments for the Work Item Resumed method.
Table 95. 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 96 lists the arguments for the Work Item Started method.
Table 96. Arguments for Work Item Started Method
Argument Display Name / Data Type
|
Argument Name
|
Type
|
Required
|
Comment
|
Channel Profile
(type: String)
|
MediaProfile
|
Input
|
Y
|
Name of driver profile that owns this work item
|
Channel Type
(type: String)
|
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 97 lists the arguments for the Work Item Suspended method.
Table 97. 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
|
