Configuring ARS Server Operations Services
An ARS Server Operations service executes one of the supported ARS Server operations. When you select one of the supported server operations in the service template, the input and output parameters of the adapter service change based on the operation selected.
If the server operation is successful, the adapter service returns the status output variable set to SUCCESS and the following output for each operation:
Operation | Output on SUCCESS status |
Execute Process | The output of the process:  statusCode The AR System Java client API returns an integer identifying the status of the operation. A value of 0 indicates success. Any other value indicates a failure. statusMessage The AR System Java client API returns a string containing the process output. Based on the outcome of the operation, this string contains either result data or an error message. For more information about the AR System JAVA client API, see the BMC Remedy documentation. |
Get Operation Time | The timestamp of the operation. statusMessage The AR System Java client API returns a string containing the process output. Based on the outcome of the operation, this string contains either result data or an error message. For more information about the AR System JAVA client API, see the BMC Remedy documentation. |
Begin Bulk Entry Transaction | Marks the beginning of a Bulk Entry Transaction: statusMessage The value is a status message that the AR System server returns only when a failure occurs. |
End Bulk Entry Transaction | If the execution of a queued call resulted in a new entry as output, the new entry ID: results Array of IData (IS Document type). Each result document contains the following fields: callType An integer that indicates the operation type. For example, 1 for create operation, 2 for update operation. entryID The entry ID value of the new entry. This value is returned only for the create operation. In all other cases the value is null. statusMessage The value is the status message for the associated Bulk Entry Transaction operation that the AR System server returns. For information about the Bulk Entry Transaction results, see the BMC Remedy documentation. |
If the ARS Server Operations adapter service encountered an error and the operation could not be executed, the adapter service returns the status output variable set to FAILURE and Remedy Adapter logs details about the failure into the Integration Server server log.
For more information about the template used to create these services, see
ARS Server Operations Adapter
Service. For more information about adapter services, see
Using Adapter Services.
To configure an ARS Server Operations service
2. Start Designer.
3. Using Designer, perform the following:
a. Right-click the package in which the service should be contained and select New > Adapter Service.
b. Select the parent namespace and type a name for the adapter service.
c. Click Next.
4. Select Remedy Adapter as the adapter type and click Next.
5. Select the appropriate Adapter Connection Name and click Next.
Important:
You must use the same adapter connection for the Begin Bulk Entry Transaction and the End Bulk Entry Transaction operations. Only the Begin Bulk Entry Transaction and End Bulk Entry Transaction adapter services executed with the same adapter connection will be part of a transaction. Begin and End Bulk Entry Transaction service pairs that use the same adapter connection cannot be nested within one another.
6. From the list of available templates, select the ARS Server Operations template and do the following:
Select a package and folder to contain the service, type a unique name for the service.
7. Click Finish.
The service is created and its parameters and controls are displayed in Designer.
8. In the editor, in the Operation field on the ARS Server Operation tab, select the ARS Server operation that you require.
When you select one of the ARS Server operations, the input and output parameters of the adapter service change based on the operation selected.
9. Specify the following values based on the selected ARS Server operation:
Operation | Parameter | Description/Action |
Execute Process | command | Specify the command to execute on the AR System Server. |
| wait | Specify whether the service waits for the process to complete. Valid values: TRUE The service waits for the process to complete. FALSE The service does not wait for the process to complete. |
Get Operation Time | None. | |
Begin Bulk Entry Transaction | None. | |
End Bulk Entry Transaction | send | Specify whether the adapter transmits the queued entry calls to the server. Valid values: TRUE The service transmits the queued entry calls to the server and ends the transaction. FALSE The service removes the queued entry calls and ends the transaction. |
10. You can select the Adapter Settings tab at any time to confirm adapter properties such as adapter name, connection name, and service template, as needed.
11. The Input/Output tab lists the input and output parameters for the adapter service. If this service is later used in a flow, its input and output signatures will be visible in the flow editor.
For additional information about using the Input/Output tab, see the webMethods Service Development Help for your release.
12. From the File menu, select Save.