Bookshelf v7.7: Server Requests Business Service

The Server Requests business service is for sending generic requests to the server request broker. The Server Requests business service can send requests in three different modes: asynchronous, synchronous or schedule mode. While in synchronous mode, it will send the request to the server request broker and wait for a response. Otherwise, it will just send the request but does not wait for a response.

When invoking the Server Requests business service to submit a component request, you need to specify SRBroker parameters in the input property set and all component specific parameters in a child property set. There are two points to note: There is no validation for component parameters passed in the child property set, and these arguments do not appear in the picklist in the workflow administration views.

NOTE: If you want to pass parameters to the server component that are not listed as available arguments, you can create a custom business service that contains the necessary parameters. Alternatively, you can create a component job that has the parameters defined as part of the job definition.

Submit Request Arguments

Table 75. Submit Request Method Arguments
Argument	Description
Component	Required (if Component Job is not entered). Enter the name of the server component to run.
Component Job	Required (if Component is not entered). Enter the name of the component job to run.
Delete After	Optional. Number of iterations before deleting the request. Works with Delete After Units. The default value is 0 (zero).
Delete After Units	Optional. The units to measure the iterations for the Delete After argument. The default value is "NoReq" for synchronous (request is not saved to the database) and "Eon" for asynchronous (request is never deleted). Other possible values are: ASAP SECONDS MINUTES HOURS DAYS WEEKS MONTHS YEARS
Description	Optional. A description of the server request.
Hold Flag	Optional. For asynchronous requests only. Flag to indicate whether or not to hold the request.
Maximum Execution Time	For future use.
Method	Optional. Only applicable for service-based server components (for example, Workflow Process Manager, Communications Manager). Specify the business service method to invoke.
Mode of Server Request	Required. This tells the server request broker how to handle the server request. While in auto mode, the server request broker will set the mode to either synchronous or schedule, depending if the client is connected or mobile. Sync: Synchronous Async: Asynchronous Schedule: Schedule Auto: Automatic configuration
Request ID Needed	Optional. This is only applicable to asynchronous and schedule mode. If this is set to false, these two server requests will return even faster.
Request Key	For future use.
Repeat Interval	Optional. The interval for repeating requests.
Number of Repetitions	Optional. The number of repetitions for repeating requests.
Repeat From	Optional. Possible values are Scheduled Start, Actual Start, and End.
Repeat Interval Units	Optional. Unit of intervals for repeating requests.
Server Name	Optional. Enter the specific server that this request is to be run from.
Start Date	Optional. Start date and time.
Storage Amount	Optional. Enter the amount of time that the server request will be stored in the database in the event that the server is down.
Storage Units	Optional. Enter the units to measure the iterations for the Storage Amount argument. The units are the same as Delete After Units.

Server Requests Business Service

Submit Request Arguments

Cancel Request Method Arguments