Configuring an AS4 outbound two-way synchronous exchange profile

An exchange profile defines how messages are exchanged with a trading partner, and how those messages are processed internally. In an outbound exchange profile you must specify the configuration that is required for sending messages to a partner.

Before you begin

You also can import an exchange profile as a resource from another installation of AS4 Microservice. For more information, see ../reference/as4/meg_resource_commands.html. Also, through the user interface, you can upload an exchange profile that has been saved as an XML jumpstart file from another installation of AS4 Microservice.

About this task

When you create an AS4 outbound two-way synchronous exchange profile, you must associate a conformance policy with the exchange profile. You also must specify the message exchange pattern, participating organizations, receivers, destinations, and connection settings. In an outbound exchange, your organization is the initiator of the message that is sent to the partner.

The exchange profile uses the owner organization of the conformance policy. In the conformance policy, you must specify either the default B2B Master Organization owner organization or a customized owner organization.

When you are creating an exchange profile, you can browse to other pages or tabs of the user interface if required. The information that you have entered for the exchange profile is saved and you can complete the exchange profile configuration and deploy it at a later time. A progress bar on the Exchange Profiles collection page (Exchanges > Exchange Profiles) indicates the percentage of completion of the exchange profile. A percentage of 20 is allocated to each of the following components of the exchange profile:

  • Exchange profile name
  • Trading partner configuration
  • Trigger
  • Action
  • Deployment
When all the components are configured, the progress bar indicates 100 percent, denoting that the exchange profile configuration is complete and the exchange profile is deployed.

Procedure

To create an AS4 outbound exchange profile:

  1. Log in to AS4 Microservice as the Master Account Administrator.
  2. Click Exchanges > Exchange Profiles.
  3. On the Exchange Profiles page, click New > AS4 Outbound.
  4. In the New Exchange Profile dialog box, specify values for the following fields and click Save.
    Field Description
    Profile name Specify a unique name for the outbound exchange profile.
    Select the message exchange pattern for the profile Select AS4 Outbound Two-Way/Sync.

    Use an AS4 Outbound Two-Way/Sync exchange pattern when you are exchanging two user message units between your organization and the partner. In a two-way sync outbound flow, your organization sends the first user message (the request) to the partner. The partner responds with a related user message (the reply).
    Conformance policy

    Specify the conformance policy that you want to associate with the exchange profile. For a message exchange, a conformance policy defines the settings for the owner organization, security, reception awareness, error handling, notification, and file size optimization. Select the conformance policy that suits your requirements.

    Use one of the following methods to specify a conformance policy:

    • To specify an existing conformance policy, click Select. The Conformance Policy list includes three default conformance policies (Minimal Client, Light Client, and EbHandler) and the custom conformance policies that you have configured.
    • To create a new conformance policy, click Add Conformance Policy.

    After you specify a conformance policy, click Save.
  5. Click Edit corresponding to the Basic Properties section, specify values for the following fields, and click Save.
    Note: When configuring the exchange profile, you must not assign the value Any to the following fields:
    • Service
    • Service type
    • Sender ID
    • Receiver ID
    • Sender ID type
    • Receiver ID type
    Any is a reserved value. It is used for exchange profile look up when the any of the preceding fields do not have a user assigned value.
    Field Description
    Name Name of the exchange profile. The name that is entered in the Profile name field is populated here.
    Description Optional: Type a description for the exchange profile.
    Service Optional: You can specify a mutually agreed on (between your organization and the partner) service or a service designed by a standards organization, for which the exchange profile can be used. For example, if supplier order processing service is specified, the exchange profile is used for processing supplier orders.

    Example of a service is urn:example.org:services:SupplierOrder Processing.
    Service type Optional: The service type indicates how the participating organizations interpret the service.

    For example, the supplier order processing service can have collect quotations, purchase order request, purchase order conformation, and purchase order update as the types.

    Example of a service type is QuoteToCollect.
    Agreement URI Optional: Type the URI of the location of the agreement (related to the processing-mode parameter configuration and operation) between your organization and the partner. The URI must be agreed on by you and your trading partner.

    Example of an agreement URI is, http://registry.example.com/cpa/123456.
    Processing mode ID Optional: Specify the mutually agreed on processing mode ID that is used to identify the processing mode configuration of the conformance policy.

    Example of a processing mode ID is SupplierOrderProcessing.PMode.
    Override party ID Optional: Select the Allow business partner ID to be overridden check box to override the business partner ID that is specified in the exchange profile and use the ID that is specified in the business document object (BDO) by the business application or in an user exit.
  6. Click Participating Organizations to specify the participating organizations.
    Field Description
    Owner Organization

    The owner organization is specified by default from the owner organization in the conformance policy of the exchange profile. In an outbound exchange profile, the owner organization is the initiator or producer of a message.
    Owner role Optional: The owner role is specified by default. To customize the role, remove the default role and enter a new one.
    Sender ID Optional: Click New and type a sender ID. The sender ID is the unique business identifier that is used to identify your organization. The ID can be mutually agreed on or assigned by an international code designator. For example, a DUNS ID.

    If sender ID type is not specified, the sender ID must be a valid unique resource identifier (URI).
    Sender ID type Optional: Click New and specify a sender ID type.

    The sender ID type indicates the area or domain to which the content of the sender ID of the trading partner organization belongs to.

    It is recommended that the value of the sender ID type be an URI. For example, urn:oasis:names:tc:ebxml-cppa:partyidtype:duns. However, the type can be any text or term that is mutually agreed on with the partner.
    Trading Partner Organization Click Select and select the trading partner organization. In an outbound exchange profile, the trading partner is the consumer or responder of the message.

    To create a new trading partner organization, click New Organization.
    Trading partner role Optional: The trading partner role is specified by default. To customize the role, remove the default role and enter a new one.
    Receiver ID Click New and type a receiver ID. The receiver ID is the unique business identifier that is used to identify the trading partner. The ID can be mutually agreed on or assigned by an international code designator. For example, a DUNS ID.

    If receiver ID type is not specified, the receiver ID must be a valid unique resource identifier (URI).
    Receiver ID type Optional: Click New and specify a receiver ID type.

    The receiver ID type indicates the area or domain to which the content of the receiver ID of the owner organization belongs.

    It is recommended that the value of the receiver ID type be an URI. For example, urn:oasis:names:tc:ebxml-cppa:partyidtype:duns. However, the type can be any text or term that is mutually agreed on with the partner.
  7. Click Outbound Push Request section and specify the Trigger and Action settings for the outbound push request.
    • In the Trigger section, specify the messaging receiver where the business application sends the message to the message queue.
    • In the Action section, specify the HTTP or HTTPS destination where the message is sent and the connection settings for the exchange profile.
    Field Description
    Select Receiver Click Select and select the messaging receiver where the business application sends the message. The AS4 outbound flow is triggered when the specified message fabric receiver receives a message from the business application.

    To select a another messaging receiver, click Remove and select a new receiver.

    To create a new messaging receiver, click New Messaging Receiver.
    Select destination Click Select and select the HTTP or HTTPS destination where the message is sent.

    To select a another destination, click Remove and select a new destination.

    To create a new destination, click New Destination.
    Configure connection For information about configuring connection settings for an outbound two-way synchronous request, see Configuring connection settings for outbound two-way synchronous exchange profile.

    To edit the connection settings, click Edit.

    To remove the connection settings, click Remove.
  8. In the Synchronous Response section, specify the configuration for the synchronous response that is received from the trading partner.
    Field Description
    Response Settings Click Configure, select the certificate that is used to verify the response signature, and click Save.

    To add a certificate, click Add certificate.

    To remove the response settings, click Remove.
  9. In the Deploy Exchange Profile section, click Deploy to deploy or enable the exchange profile.
    If the exchange profile configuration is incomplete, a list of items that must be configured to complete the exchange profile configuration is displayed in the Deploy Exchange Profile section. The Deploy button is enabled only when all the sections of the exchange profile are in Complete status.
    Note: When you update an exchange profile after deploying, the percentage complete shows as 80%, but the status shows as Deployed. For the updates to take effect and the percentage complete to show as 100 percent, you must redeploy the exchange profile.