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 any steps that generate or save files to the AIS Server, you can create a REST connector to transfer the generated file to an external system.

  1. Click the Connectors icon on the Orchestrator Studio Home page.

  2. On the Connectors side panel, click the New drop-down menu and select REST.

  3. Create and name the connector service request as described in Creating a Component.

  4. On the Connectors design page, click the REST field and select a connection

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

  6. 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.

    (Release The Number of Threads option is displayed when you enable the Fire and Forget toggle. This option enables you to select the number of threads for an iterated step.

  7. 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.

  8. 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 that is returned from a report service request to this variable. Alternatively, 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. Alternatively, 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. If the file is in the AIS temporary directory, enter just the name of the file. If the file is in another accessible file location on the AIS server, enter the fully qualified path of the file.

      Click the Use Temporary File Location option to include a file from the temporary directory on the AIS Server

    • Remove File. This option is enabled by default, and removes the file from the temporary directory on the AIS Server after the file is transferred.

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

Note: The variable notation ${variable} is supported for multi-part REST connectors. Add one or more variables in any of the entry fields to pass values to the connector. The inputs displayed in the test window depict the variables you entered (Release 9.2.5).