Table 128. Arguments for Create and Submit Request Method
Argument Display Name / Data Type |
|
|
|
|
# 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 the user interface for creating outbound requests.) |
# 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 reply email addresses to be used by recipients of email messages generated by the request. |
Only Send Preference Flag (type: String) |
RequestSendFlag |
Input |
N |
(Currently this is set only from the user interface for creating outbound requests.) 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. |
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 for creating outbound requests.) |
Test Address (type: String) |
TestAddress |
Input |
N |
Recipient address (for the To line) to use for testing, which overrides all others. If set to Null (case insensitive), communications drivers will not be loaded and messages will not be sent. |
Web Server (type: String) |
WebServer |
Input |
N |
The Web server to be used for Siebel bookmarks (URLs). 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. |