Arguments for Create and Submit Request Method
The following table lists the arguments for the Create and Submit Request (CreateRequest) method.
| Argument Display Name and Data Type | Argument Name | Type | Req’d | Comment |
|---|---|---|---|---|
# of Recipients (type: String) |
NumRecipients |
Input |
No |
Estimated total number of recipients. Used as a hint for auto-adjustment of number of subtasks. (Not available from the user interface for creating outbound requests.) |
# of Tasks (type: String) |
NumTasks |
Input |
No |
Number of subtasks to run. This number is based on each recipient’s last name. |
Child Recipient Search Spec (type: String) |
ChildRecipSearchSpec |
Input |
No |
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 |
No |
Communications profile to use for all communications templates in this request. |
Comm Template Name List (type: String) |
PackageNameList |
Input |
Yes |
Semicolon-delimited list of communications template names. |
Comments (type: String) |
Comments |
Input |
No |
Comments for the request. Corresponds to Comments field for the request. |
Create Only (type: String) |
CreateOnly |
Input |
No |
Creates the communication request without any associated source, recipient, or template records specified. Used when creating a parent request. |
Default Preference (type: String) |
RequestDefaultMedium |
Input |
No |
Communications channel to use if Only Send Preference is selected for the request and the channel preference is not specified for a recipient. Corresponds to Default Preference field for the request. |
Defined Component (type: String) |
DefinedComponent |
Input |
No |
Name of the defined Siebel Server component to receive this request. This name is based on CommOutboundMgr. Corresponds to Component Name field for the request. |
Message Reply Address List (type: String) |
MsgReplyAddressList |
Input |
No |
Semicolon-delimited list of email addresses. Recipients of email messages generated by the request can use this list. The list specifies email addresses that the recipient can reply to. |
Only Send Preference Flag (type: String) |
RequestSendFlag |
Input |
No |
(Currently you can set this argument only from the user interface for creating outbound requests.) Corresponds to Only Send Preference field for the request. |
Recipient Group (type: String) |
RecipientGroup |
Input |
Yes |
Source business object and recipient business component that is selected from the Recipient Group drop-down list. Corresponds to Recipient Group field for the request. |
Recipient Search Spec (type: String) |
RecipSearchSpec |
Input |
No |
Search specification to filter the recipients that the recipient business component returns. |
Request End Date (type: String) |
EndDate |
Output |
No |
Date or time that the request finished. Corresponds to End Time field for the request. |
Request ID (type: String) |
CommRequestId |
Output |
No |
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 |
No |
Language applicable to this request. The value for this argument is derived, in priority order, from:
It is assumed that all recipients for a request share a common language and locale. |
Request Locale Code (type: String) |
RequestLocaleCode |
Input |
No |
Locale applicable to this request. The value for this argument is derived, in priority order, from:
It is assumed that all recipients for a request share a common language and locale. |
Request Name (type: String) |
RequestName |
Input |
No |
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 |
No |
ID for the parent request of this communication request (when current request is a subrequest). Corresponds to Request # field for the request. |
Request Start Date (type: String) |
StartDate |
Output |
No |
Date or time the request started. Corresponds to Start Time field for the request. |
Source ID List (type: String) |
SourceIdList |
Input |
Yes |
Semicolon-delimited list of IDs for recipient source records. |
SRM Request ID (type: String) |
SRMRequestId |
Output |
No |
ID for the server request for this communication request, as known to Server Request Broker. |
Status (type: String) |
Status |
Output |
No |
Status of the request. Corresponds to Status field for the request. |
Status Message (type: String) |
StatusMessage |
Output |
No |
Request status message. Corresponds to Status Message field for the request. |
Task Recipient Minimum (type: String) |
TaskRecipMin |
Input |
No |
Preferred minimum number of recipients for a subtask. A warning issued if this number is not met. (Not available from the user interface for creating outbound requests.) |
Test Address (type: String) |
TestAddress |
Input |
No |
Recipient address (for the To line) to use for testing. This address overrides all other addresses. If set to Null (case insensitive), then communications drivers are not loaded and messages are note sent. |
Web Server (type: String) |
WebServer |
Input |
No |
Web server to use for Siebel bookmarks (URLs). This argument corresponds to the WebServer parameter for Communications Outbound Manager. For more information, see Configuring Communications Outbound Manager. For information about the description for the Create Bookmark check box for advanced templates, see Fields for Templates. |