Arguments for Submit Request Method

The following table lists the arguments for the Submit Request (SubmitRequest) 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 user interface.)
# 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.
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.
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 the request finished. Corresponds to End Time field for the request.
Request ID (type: String)	CommRequestId	Input	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: 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	No	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	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.
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	Address to use for testing. This address overrides all other addresses. If it is set to Null (case insensitive), then communications drivers are not loaded and message 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.