Configuring a REST Connector to Transfer Files to a REST Service

You can configure a REST connector to transfer files to a REST service. When added to an orchestration that includes a report service request, a REST connector can transfer the output of the report service request to an external system. Also, if an orchestration includes a custom service request that uses a Groovy script to generate and save a file to the AIS Server, you can create a REST connector to transfer the generated file to an external system.

1. Create and name the connector service request as described in Creating Service Requests.

2. On the Connector design page, click the Connection field and select a connection under the REST category.

   The Orchestrator Studio displays the URL to the REST service available through the connection.

3. Click the HTTP Method drop-down list and select POST.

4. Enable the Fire and Forget toggle if you want the orchestration to execute without waiting for a response.

   If Fire and Forget is enabled, the Output section is hidden because the REST service response is not processed.

5. In the File section of the request, enter the File Part Name, which you can find in the documentation for the REST API you are calling.

6. Select the Report or File option to specify the type of file you are sending, and then complete the following fields accordingly:

   For Report, complete these fields:

   • Job Number. Enter ${variablename} to use a variable for the job number. When you add this connector to an orchestration, you can map the job number of a report returned from a report service request to this variable. Or instead of a variable, you can enter an actual job number.

   • Execution Server. Enter the server where the report was generated. Enter ${variablename} to use a variable for the server name. When you add this connector to an orchestration, you can map the name of this server from the report service request, which returns the name of this server. Or instead of variable, you can enter the server name.

   • File Type. Select the file type of the output.

   For File, complete these fields:

   • Source File Name. Enter the name of the file that was created in the custom Groovy service request.

   • Remove File. Enabled by default, this removes the file from the temporary directory on the AIS Server after the file is transferred.

7. If the REST API being called requires additional information, you can use the table at the bottom of the File section to include additional details.