Siebel Communications Server Administration Guide > Communications Server Business Services > Outbound Communications Manager Methods >

Arguments for Outbound Communications Manager Methods

This section lists the arguments for each method of the business service Outbound Communications Manager.

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

Arguments for Create and Submit Request Method

Table 122 lists the arguments for the Create and Submit Request method.

Table 122.  Arguments for Create and Submit Request Method
Argument Display Name / Data Type
Argument Name
Type
Required
Comment
# of Recipients
(type: String)
NumRecipients
Input
N
Estimated total number of recipients. Used as hint for auto-adjustment of number of subtasks. (Not available from user interface.)
# of Tasks
(type: String)
NumTasks
Input
N
The number of subtasks to run, based on each recipient's last name.
Child Recipient Search Spec
(type: String)
ChildRecipSearchSpec
Input
N
Search specification to filter iteration child business component, in the form child_BC_name: child_recip_search_spec.
Comm Profile Override
(type: String)
CommProfileOverride
Input
N
Communications profile to be used for all communications templates in this request.
Comm Template Name List
(type: String)
PackageNameList
Input
N
Semicolon-delimited list of communications template names.
Comments
(type: String)
Comments
Input
N
Comments for the request.
Corresponds to Comments field for the request.
Create Only
(type: String)
CreateOnly
Input
N
Create the communication request without any associated source, recipient, or template records specified. Used when creating a parent request.
Default Preference
(type: String)
RequestDefaultMedium
Input
N
Communications channel to use if Only Send Preference is checked for request, and channel preference is not specified for a recipient.
Corresponds to Default Preference field for the request.
Defined Component
(type: String)
DefinedComponent
Input
N
Name of the defined Siebel Server component, based on CommOutboundMgr, that is to receive this request.
Corresponds to Component Name field for the request.
Message Reply Address List
(type: String)
MsgReplyAddressList
Input
N
Semicolon-delimited list of email addresses to be used for all recipients in this request.
Only Send Preference Flag
(type: String)
RequestSendFlag
Input
N
(Currently this is set only from the user interface.)
Corresponds to Only Send Preference field for the request.
Recipient Group
(type: String)
RecipientGroup
Input
N
Recipient group: the source business object and recipient business component, as selected from the Recipient Group picklist.
Corresponds to Recipient Group field for the request.
Recipient Search Spec
(type: String)
RecipSearchSpec
Input
N
Search specification to filter the recipients returned by the recipient business component.
Request End Date
(type: String)
EndDate
Output
N
Date/time the request finished.
Corresponds to End Time field for the request.
Request ID
(type: String)
CommRequestId
Output
N
ID for this communication request. A request must use either Request ID or Request Name.
Corresponds to Request # field for the request.
Request Language Code
(type: String)
RequestLanguageCode
Input
N
The language applicable to this request. The value for this argument is derived, in priority order, from:
  • A value explicitly specified for this parameter, such as in a workflow process, or
  • The language specified for the first template for the request, or
  • The language applicable to the current Application Object Manager.
It is assumed that all recipients for a request share a common language and locale.
Request Locale Code
(type: String)
RequestLocaleCode
Input
N
The locale applicable to this request. The value for this argument is derived, in priority order, from:
  • A value explicitly specified for this parameter, such as in a workflow process, or
  • The locale specified for the first template for the request, or
  • The locale applicable to the current Application Object Manager.
It is assumed that all recipients for a request share a common language and locale.
Request Name
(type: String)
RequestName
Input
N
Name for this communication request. A request must use either Request ID or Request Name.
Corresponds to Description field for the request.
Request Parent ID
(type: String)
CommRequestParentId
Input
N
ID for the parent request for this communication request (when current request is a subrequest).
Corresponds to Request # field for the request.
Request Start Date
(type: String)
StartDate
Output
N
Date/time the request started.
Corresponds to Start Time field for the request.
Source ID List
(type: String)
SourceIdList
Input
N
Semicolon-delimited list of IDs for recipient source records.
SRM Request ID
(type: String)
SRMRequestId
Output
N
The ID for the server request for this communication request, as known to the Server Request Broker (formerly Server Request Manager).
Status
(type: String)
Status
Output
N
Status of the request.
Corresponds to Status field for the request.
Status Message
(type: String)
StatusMessage
Output
N
Request status message.
Corresponds to Status Message field for the request.
Task Recipient Minimum
(type: String)
TaskRecipMin
Input
N
Preferred minimum number of recipients for a subtask; warning issued if not met. (Not available from the user interface.)
Test Address
(type: String)
TestAddress
Input
N
Address to use for testing, which overrides all others. If it is set to Null (case insensitive), communications drivers will not be loaded and message will not be sent.
Web Server
(type: String)
WebServer
Input
N
The Web server to be used for URL bookmarks.
This argument corresponds to the WebServer parameter for Communications Outbound Manager. For details, see Configuring Communications Outbound Manager.
See also the description for the Create Bookmark check box for advanced templates, in Fields for Templates.

Arguments for Send Message Method

Table 123 lists the arguments for the Send Message method.

Table 123.  Arguments for Send Message Method
Argument Display Name / Data Type
Argument Name
Type
Required
Comment
Bcc Address List
(type: String)
MsgBccList
Input
N
Semicolon-delimited list of email addresses for the BCC line.
Cc Address List
(type: String)
MsgCcList
Input
N
Semicolon-delimited list of email addresses for the CC line.
Communication Profile
(type: String)
CommProfile
Input
Y
Name of the communications profile used to send the message.
Message Body
(type: String)
MsgBody
Input
N
Email message body content, which may be specified from a workflow process or script.
How the content is processed depends in part on whether the argument type is Expression or Literal.
For example, when the type is Expression, you can enter operators such as +, specify field names for substitution, and enclose literal strings in quotes. Carriage returns to be included in output must be enclosed in quotes, such as in this example:
"New Quote" + "
" + [Quote Number]
For more information, refer to Siebel Business Process Designer Administration Guide.
Message Subject
(type: String)
MsgSubject
Input
N
Descriptive subject line for the email message.
Mobile Media Type
(type: String)
MobileMediaType
Input
N
For a wireless message, this argument should be set to Wireless. This argument should be empty in all other cases.
Reply to Address List
(type: String)
MsgReplyAddressList
Input
N
Semicolon-delimited list of email addresses to be used for all recipients.
To Address List
(type: String)
MsgToList
Input
N
Semicolon-delimited list of email addresses for the To line.
For a wireless message, this argument should contain a list of contact IDs to send the message to.

Arguments for Send SMTP Message Method

Table 124 lists the arguments for the Send SMTP Message method.

Table 124.  Arguments for Send SMTP Message Method
Argument Display Name / Data Type
Argument Name
Type
Required
Comment
Bcc Address List
(type: String)
MsgBccList
Input
N
Semicolon-delimited list of email addresses for the BCC line.
Cc Address List
(type: String)
MsgCcList
Input
N
Semicolon-delimited list of email addresses for the CC line.
From Address
(type: String)
FromAddress
Input
Y
The email address of the sender.
Message Body
(type: String)
MsgBody
Input
N
Email message body content, which may be specified from a workflow process or script.
How the content is processed depends in part on whether the argument type is Expression or Literal.
For example, when the type is Expression, you can enter operators such as +, specify field names for substitution, and enclose literal strings in quotes. Carriage returns to be included in output must be enclosed in quotes, such as in this example:
"New Quote" + "
" + [Quote Number]
For more information, refer to Siebel Business Process Designer Administration Guide.
Message Subject
(type: String)
MsgSubject
Input
N
Descriptive subject line for the email message.
To Address List
(type: String)
MsgToList
Input
N
Semicolon-delimited list of email addresses for the To line.

Arguments for Submit Request Method

Table 125 lists the arguments for the Submit Request method.

Table 125.  Arguments for Submit Request Method
Argument Display Name / Data Type
Argument Name
Type
Required
Comment
# of Recipients
(type: String)
NumRecipients
Input
N
Estimated total number of recipients. Used as hint for auto-adjustment of number of subtasks. (Not available from user interface.)
# of Tasks
(type: String)
NumTasks
Input
N
The number of subtasks to run, based on each recipient's last name.
Child Recipient Search Spec
(type: String)
ChildRecipSearchSpec
Input
N
Search specification to filter iteration child business component, in the form child_BC_name: child_recip_search_spec.
Comm Profile Override
(type: String)
CommProfileOverride
Input
N
Communications profile to be used for all communications templates in this request.
Defined Component
(type: String)
DefinedComponent
Input
N
Name of the defined Siebel Server component, based on CommOutboundMgr, that is to receive this request.
Corresponds to Component Name field for the request.
Recipient Search Spec
(type: String)
RecipSearchSpec
Input
N
Search specification to filter the recipients returned by the recipient business component.
Request End Date
(type: String)
EndDate
Output
N
Date/time the request finished.
Corresponds to End Time field for the request.
Request ID
(type: String)
CommRequestId
Input
N
ID for this communication request. A request must use either Request ID or Request Name.
Corresponds to Request # field for the request.
Request Language Code
(type: String)
RequestLanguageCode
Input
N
The language applicable to this request. The value for this argument is derived, in priority order, from:
  • A value explicitly specified for this parameter, such as in a workflow process, or
  • The language specified for the first template for the request, or
  • The language applicable to the current Application Object Manager.
It is assumed that all recipients for a request share a common language and locale.
Request Locale Code
(type: String)
RequestLocaleCode
Input
N
The locale applicable to this request. The value for this argument is derived, in priority order, from:
  • A value explicitly specified for this parameter, such as in a workflow process, or
  • The locale specified for the first template for the request, or
  • The locale applicable to the current Application Object Manager.
It is assumed that all recipients for a request share a common language and locale.
Request Name
(type: String)
RequestName
Input
N
Name for this communication request. A request must use either Request ID or Request Name.
Corresponds to Description field for the request.
Request Parent ID
(type: String)
CommRequestParentId
Input
N
ID for the parent request for this communication request (for when current request is a subrequest).
Corresponds to Request # field for the request.
Request Start Date
(type: String)
StartDate
Output
N
Date/time the request started.
Corresponds to Start Time field for the request.
Status
(type: String)
Status
Output
N
Status of the request.
Corresponds to Status field for the request.
Status Message
(type: String)
StatusMessage
Output
N
Request status message.
Corresponds to Status Message field for the request.
Task Recipient Minimum
(type: String)
TaskRecipMin
Input
N
Preferred minimum number of recipients for a subtask; warning issued if not met. (Not available from the user interface.)
Test Address
(type: String)
TestAddress
Input
N
Address to use for testing, which overrides all others. If it is set to Null (case insensitive), communications drivers will not be loaded and message will not be sent.
Web Server
(type: String)
WebServer
Input
N
The Web server to be used for URL bookmarks.
This argument corresponds to the WebServer parameter for Communications Outbound Manager. For details, see Configuring Communications Outbound Manager.
See also the description for the Create Bookmark check box for advanced templates, in Fields for Templates.


 Siebel Communications Server Administration Guide 
 Published: 23 June 2003