Creating RA Web Service SOAP Agent Jobs

To run a SOAP web service, you need to create an RA Web Service SOAP Agent Job.

To create an RA Web Service SOAP Agent Job:

  1. Add a Job object of type WEBSERVICESOAP > SOAP and select your RA Web Service SOAP Agent in the Host field on the Attributes page.
  2. Select the Web Service tab.
  3. In the General and URL Endpoint and reporting sections, respond to the fields described below.
    4. Field Description

    Connection

    		 A RA Web Service SOAP AgentConnection object. The Connection object you select can connect to any RA Web Service SOAP Agent solution Agent object that's available on the client. For more information on RA Web Service SOAP Agent Connection objects, see topic Creating RA Web Service SOAP Agent Connection Objects.

    Service

    		 A non-editable field that shows the service for the selected Connection object.

    Port

    		 A non-editable field that shows the port for the selected Connection object.

    Operation

    The available methods for the web service. When you select an operation, XML for the request is written to the Job definition. You view and edit the XML by selecting the Request > XML menu item on the left side of the screen.

    If you change the operation, the existing XML including any edits you have made will be erased. Note that you will get a confirmation pop-up message allowing you to confirm the change when you select a new operation.

    Include required fields only in generated XML request

    When selected, only required fields will be written to the XML in the Job definition when you select an operation in the Operation field above.

    Remove template values from generated XML request

    When selected, the default template values will be removed from the XML when you select an operation in the Operation field above. In the example below, REQUEST_VALUE_symbol is automatically written as a template value for Strings.

    <symbol>REQUEST_VALUE_symbol</symbol>

    When this box is checked, the template value REQUEST_VALUE_symbol is removed as shown below.

    <symbol></symbol>

    Overwrite URL Endpoint

    		 Allows the Job to override the URL Endpoint from the connection. When checked the URL Endpoint field below becomes editable.

    URL Endpoint

    An optional field where you can override the URL endpoint defined in the Connection object. When this field is non-editable (the Overwrite URL Endpoint checkbox is not selected), the Connection URL Endpoint is shown.

    When the Overwrite URL endpoint checkbox is selected, the field becomes editable and changes to the selected Connection object will have no effect on this Jobs URL Endpoint.

    Write request and response to log

    		 Includes the XML for the request and response in the Job log.

    Create XML SOAP request report

    		 Creates a Job report the XML for the SOAP request. These reports are written to the soap_reports directory.

    Create XML SOAP response report

    Creates a Job report with the XML for the SOAP response. These reports are written to the soap_reports directory.
  4. Specify request and response settings using the menu items on the left side of the screen as documented in the following topics.

Deleting Registered Files

Registered output files for RA Web Service SOAP Agent Jobs are saved to the task_reports directory under the bin directory. They will remain there until you move or delete them.