Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Predefined Business Services >
Table 77. Method Arguments for FINS Dynamic UI
Server Requests Business Service
This topic describes the predefined Server Requests business services. It includes the following topics:
For more information, see Examples That Use the Server Requests Business Service. You can use the predefined Server Requests business service to send a generic request to the Server Request Broker. The Server Requests business service can send a request in the following modes:
- Asynchronous
- Synchronous
- Schedule
Using Synchronous and Asynchronous Modes with the Server Requests Business Services
The Server Requests business service sends a request to the Server Request Broker, and then waits or does not wait for a reply depending on the following mode that it uses:
- Synchronous. Waits for a reply.
- Asynchronous. Does not wait for a reply.
It is recommended that you use the Server Requests business service in most situations rather than the Workflow Process Manager (Server Request) business service. It is more efficient to make an asynchronous call to a workflow process. If Siebel CRM makes a synchronous call to a workflow process, then this workflow process runs in the Object Manager and the user must wait for the workflow process to end. Parameters of the Server Request Broker
If you configure Siebel CRM to call the Server Requests business service to send a component request, then you must do the following work:
- Define parameters for the Server Request Broker in the input property set.
- Define parameters that are specific to a component in the child property set.
Consider the following items:
- If Siebel CRM calls the Server Requests business service to call a server component, then the Alias Name property must reference the names of the component parameters. The Alias Name usually does not include spaces.
- You must define parameters for components with the Alias Name in the child property set.
- Siebel Tools does not validate the Alias Name.
- Siebel CRM does not display these arguments in the drop-down list in the Administration-Business Process views.
- Failure to use the correct format results in an error message. Table 78 describes correct and incorrect formats.
Table 78. Format of the Component Parameter for Calling the Server Requests Business Service
|
|
ObjReq.SetProperty "BCName", "Account" |
ObjReq.SetProperty "Buscomp Name", "Account" |
Passing Parameters to Server Components
If you must pass parameters that Siebel CRM does not display as available arguments, then you can define a custom business service that includes the parameters that you require. You can also define a component job that includes these parameters. For more information on component jobs, see Siebel System Administration Guide. Methods That You Can Use with the Server Requests Business Service
You can use the following methods with the Server Requests Business Service:
- Submit Request. Sends a request to the Server Request Broker.
- Cancel Request. Cancels a server request that is currently waiting to run.
Arguments of the Submit Request Business Service Method
Table 79 describes arguments of the Submit Request business service method.
Table 79. Arguments of the Submit Request Business Service Method
|
|
Component |
Required if you do not specify the Component Job. Enter the name of the server component to run. |
Component Job |
Required if you do not specify the Component. Enter the name of the component job to run. |
Delete After |
Optional. Specifies the number of iterations before deleting the request. Works with Delete After Units. The default value is 0 (zero). |
Delete After Units |
Optional. Specifies the units to measure the iterations for the Delete After argument. The default value is:
- NoReq for synchronous mode where Siebel CRM does not save the request to the Siebel database
- Eon for asynchronous mode where Siebel CRM never deletes the request.
You can also use one of the following values:
- ASAP
- SECONDS
- MINUTES
- HOURS
- DAYS
- WEEKS
- MONTHS
- YEARS
|
Description |
Optional. Includes a description of the Siebel Server request. |
Enterprise Server |
Not applicable |
Hold Flag |
Optional. For an asynchronous request only. Specifies the argument that indicates whether or not to hold the request. |
Maximum Execution Time |
For future use. |
Method |
Optional. Specifies the business service method that Siebel CRM must call. You use this argument only with a server component that provides a service. For example, Workflow Process Manager or Communications Manager. |
Mode of Server Request |
Required. Instructs the Server Request Broker how to handle the Siebel Server request. While in Auto mode, the Server Request Broker sets the mode to Synchronous or Schedule, depending on if the Siebel client is connected or mobile. You can use one of the following values:
- DirectDb. Asynchronous request, written directly to the S_SRM_REQUEST table. DirectDb is case-sensitive. If you use a case other than DirectDb, such as DirectDB, then Siebel CRM might create an error.
- It is recommended that you use DirectDb to call an asynchronous request If you use DirectDb, then Siebel CRM does not lose the data in the S_SRM_REQUEST table. If you use Async, and if the Workflow Process Manager reaches MaxTasks, then it cannot process every SRM request.
- Async. Asynchronous.
- Sync. Synchronous.
- Schedule. Schedule.
- Auto. Automatic configuration.
|
Number of Retries |
Specifies the maximum number of times Siebel CRM retries the request in case of error. |
Request ID Needed |
Optional. You use this argument only with asynchronous mode or schedule mode. If you set Request ID Needed to false, then Siebel CRM returns server requests more quickly. |
Repeat Amount |
Specifies the amount of time that Siebel CRM repeats units. |
Repeat Interval |
Optional. Specifies the interval that Siebel CRM uses to repeat a request. |
Repeat From |
Optional. You can use one of the following values:
- Scheduled Start
- Actual Start
- End
|
Repeat Interval Units |
Optional. Specifies the unit of intervals that Siebel CRM uses for a repeating request. |
Repeat Number |
Optional. Specifies the number of repetitions that Siebel CRM uses for a repeating request. |
Retry On Error |
Used for resending the request if the request errors out. The default value is FALSE. |
Repeat Unit |
Specifies the unit of time that Siebel CRM uses to repeat. |
Request ID |
Used for request key routing. |
Server Name |
Optional. Enter the server name where Siebel CRM runs this request. |
Start Date |
Optional. Specifies the start date and time. |
Storage Amount |
Optional. Enter the amount of time that Siebel CRM stores the Siebel Server request in the Siebel database if the Siebel Server is down. |
Storage Units |
Optional. Enter the units that Siebel CRM uses to measure the iterations for the Storage Amount argument. The units are the same as Delete After Units. |
Component |
Required if you do not specify the Component Job. Enter the name of the server component to run. |
Arguments of the Cancel Request Business Service Method
Table 80 describes arguments for the Cancel Request business service method of the Server Requests Business Service.
Table 80. Arguments of the Cancel Request Business Service Method
|
|
Request ID |
Required. The Id of the Siebel Server request that Siebel CRM must cancel. |
Repeat Number |
Optional. The number of repetitions of the repeating server requests that Siebel CRM must cancel. |
|