1. Orchestrator Guide
  2. Creating an Open API Connection

Creating an Open API Connection

  1. On the Orchestrator Studio Home page, click the Connections icon.

  2. On the Connections side panel, click the New button and select Open API from the drop-down list.

  3. On the Connection design page, complete these fields:

    • Name. Enter a unique name for the Open API connection.

    • Description. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the location in the description.

      The Type of connection is displayed next to the Description field.

    • User/Role. Enter the user who is authorized to access the connection. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the connections reside.

  4. On the Service Information tab, in the OpenAPI Catalog field, enter the catalog URL.

  5. The Endpoint field contains the execution endpoint of the API. This field is automatically populated from the API definition. If there are multiple values, you must enter the correct endpoint. The system displays the first endpoint by default.

    This endpoint is used during the execution time and the catalog endpoint is used during the design time.

    The values for the Title, Description, Version, and Documenation fields are displayed automatically.

    Note: Open API connectors only support the OpenAPI 2.0 standard (Swagger 2.0).
    Note: As of release 9.2.5, Open API connectors support the OpenAPI 3.0 standard and the OpenAPI 2.0 standard.

  6. On the Security tab, enter the credentials for accessing the external REST services.

    • Security Policy

      Select the authentication type as Basic Authorization for accessing the Server Manager Console.

    • User

    • Password

  7. When a proxy server is present, connection is made through that server. On the Proxy tab, specify a proxy server for accessing the external server:

    • Proxy Host. Enter the URL of the proxy server.

    • Proxy Port. Enter the port number of the proxy server.

    • Use Proxy. Slide the toggle to the right to enable the proxy.

  8. Click Save.

Note:

  • Server Manager REST services can be hosted on the same server on which the Server Manager Console is hosted or on a different server.

  • The credentials that are used for accessing the REST services and the Open API documentation are same as mentioned in the Security section.