Configuring a RESTful HTTP or HTTPS outbound push exchange profile

You can configure an exchange profile to send files to a trading partner using HTTP or HTTPS as the transport protocol. Use Exchange Profiles to create and configure a new secure outbound push exchange pattern.

Before you begin

You also can import an exchange profile as a resource from another installation of AS4 Microservice. For more information about importing exchange profiles as a resource with commands, see ../reference/as4/meg_resource_commands.html.

About this task

When you are creating an exchange profile, you can still navigate to other pages or tabs of the user interface if required. Any information that is entered in the exchange profile configuration is automatically saved and can be completed and deployed later. A progress bar on the Exchange Profiles collection page indicates the percentage of completion of the exchange profile. A percentage of 20 is allocated to each of the following sections of the exchange profile:

  • Exchange Identification
  • Participating Organizations
  • Trigger
  • Action
  • Deploy Exchange Profile

When all components are configured, the progress bar displays 100%, indicating that the exchange profile configuration is complete and the exchange profile is deployed.

Procedure

To create a RESTful HTTP or HTTPS outbound push exchange profile:

  1. Log in to AS4 Microservice as a user with the permissions to configure a RESTful HTTP or HTTPS exchange profile.
  2. Click Exchanges > Exchange Profiles.
  3. On the Exchange Profiles page, click New > Protocol Outbound > RESTful HTTP or HTTPS Outbound One-Way Push.
  4. On the New Exchange Profile page, specify values for the applicable fields as follows and click Save:
    Profile name

    Enter a unique name for the new RESTful HTTP or HTTPS exchange profile.

    Exchange pattern

    Select RESTful HTTP or HTTPS Outboud One-WayPush message exchange pattern.

  5. Click Edit corresponding to the Basic Properties section, specify values for the following fields, and click Save:
    Name

    The unique name of the exchange profile that you entered in the Profile name field on the New Exchange Profile window is populated here.

    Description

    Optional: Enter a description for the exchange profile.

    Document type alias

    Optional: Specify the document type. The document type alias is user-defined and specifies the type of file that is exchanged. Many documents of different types might be put on the same queue and then routed to different exchange profiles based on the document type. Specifying a document type ensures that the document reaches the appropriate exchange profile.

    Service

    Optional: You can specify a mutually agreed on (between your organization and the partner) service, for which the exchange profile can be used. For example, if catalog updates service is specified, the exchange profile is used for receiving catalog updates.

    Service type

    Optional: The service type indicates how the participating organizations interpret the service. For example, the catalog updates service can have new product updates, existing product updates, products removed from the catalog, and so on.

    Agreement URI

    Optional: Type the URI of the location of the agreement between your organization and the partner. The URI must be agreed on by both the partners.

  6. Click Participating Organizations to specify the participating organizations:
    Owner Organization

    Click Select to select the owner organization. You can filter owning organizations by name or select an existing Organization from the menu. Click New Organization to define a new owner organization. In an outbound push exchange profile, the owner organization is the sender in the exchange.

    Owner Organization Role

    The owner organization role is selected by default and is dependent upon the type of exchange pattern. The role cannot be customized. In an outbound push exchange profile, the owner organization is always a sender role.

    Sender ID

    Click New to enter a unique sender ID. The sender ID is the unique business identifier that is used to identify the trading partner. The sender ID can be mutually agreed on by both parties or can be assigned by an international code designator, such as a DUNS ID.

    Sender ID type

    Optional: Click New to enter a sender ID type. The sender ID type is user-defined and can specify the type of sender. Many documents with different sender ID types might be put on the same queue and then routed to different exchange profiles based on the document type. Specifying a sender ID type ensures that the document reaches the appropriate exchange profile.

    Trading Partner Organization

    Click Select to select the trading partner organization. You can filter trading partner organizations by name or select an existing Organization from the menu. Click New Organization to define a new trading partner organization. In an outbound push exchange profile, the trading partner organization is the receiver in the exchange.

    Trading Partner Organization Role

    The trading partner organization role is selected by default and is dependent upon the type of exchange pattern. The role cannot be customized. In an outbound push exchange profile, the trading partner organization is always a receiver role.

    Receiver ID

    Click New to enter a unique receiver ID. The receiver ID is the unique business identifier that is used to identify the trading partner. The receiver ID can be mutually agreed on by both parties or can be assigned by an international code designator, such as a DUNS ID.

    Receiver ID type

    Optional: Click New to enter a receiver ID type. The receiver ID type is user-defined and can specify the type of receiver. Many documents with different receiver ID types might be put on the same queue and then routed to different exchange profiles based on the document type. Specifying a receiver ID type ensures that the document reaches the appropriate exchange profile.

  7. Click Trigger: Receive Message Data from Source to specify the RESTful HTTP or HTTPS Receiver for the exchange:
    Messaging Receiver

    Click Select to select a message queue receiver for the exchange profile. You can filter applicable existing message queue receivers by name or select an existing RESTful HTTP or HTTPS receiver from the menu. Click New Receiver to create a new RESTful HTTP or HTTPS receiver.

  8. Click Action: Send Data to Trading Partner to specify the Connection Settings for the exchange.
    Important: If you specified Sterling File Gateway as the receiver in the Trigger: Receive Data from Trading Partners section, the Action: Deliver Message Data section will indicate "Deliver to Sterling File Gateway" and the section is marked as completed (no configuration required).
    Destination

    Click Select to select an HTTP or HTTPS outbound destination. You can filter applicable existing destinations by name or select an existing Destination from the menu. Click New Destination to create a new HTTP or HTTPS outbound destination.

    Note: Only destinations that are configured with either basic authentication or SSL authentication are displayed.
    Configure connection

    Click Configure to access the Configure Connection Settings - HTTP REST Outbound Push page and configure the connection properties for the destination.

    User Authentication / Credential
    Click Edit to update user credentials. Click Remove to delete the user credential.
    Note: This user overrides the authentication options selected in the HTTP destination.
    User Authentication / SSL client authentication certificate

    Click Edit to update SSL credentials. Click Remove to delete the SSL credential.

    Basic Properties / Path

    Type a path to a directory on the server's file system to receive the files. This path is appended to the service URL of the selected HTTP or HTTPS destination You can select commonly used paths in other exchanges that are associated with the receiver you selected for the exchange.

  9. Click Deploy Exchange Profile section to complete and deploy your exchange profile configuration. Click Deploy to deploy or enable the exchange profile.
    Remember: If the exchange profile configuration is incomplete, a list of incomplete or unconfigured items is displayed in the Deploy Exchange Profile section. The Deploy button is enabled only when all the sections of the exchange profile have Complete status.