Configuring an AS4 inbound two-way push pull exchange profile

An exchange profile defines how messages are exchanged with a trading partner, and how those messages are processed internally.

Before you begin

You also can import an exchange profile as a resource from another installation of AS4 Microservice. For more information, see Resource Commands. 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

An inbound two-way push pull exchange involves receiving two requests from your trading partner, a push request and a pull request. You and your trading partner must agree to use an AS4 inbound two-way push pull exchange profile when the transaction involves large or multiple files. In such a situation, the business application needs more time to process the request message and your trading partner system cannot wait till the processing is complete.

Security is mandatory for a two-way push pull exchange pattern. When you create an AS4 inbound two-way push pull exchange profile, you must associate a conformance policy (Light client, Minimal, or a custom conformance policy with security enabled) that has security enabled with the exchange profile. In an inbound exchange, your organization is the responder or consumer of the message that is sent by a 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 inbound two-way push pull exchange profile, complete the following steps:

  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 Inbound.
  4. On the New Exchange Profile page, specify values for the following fields and click Save.
    Field Description
    Profile name Specify a unique name for the inbound two-way push pull exchange profile.
    Select the message exchange pattern for the profile Select AS4 Inbound Two-Way/Push-Pull message exchange pattern.
    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.

    For an AS4 inbound two-way push pull exchange profile, the default Minimal Client and Light Client conformance policies or any custom conformance policy with the following settings can be selected:

    • User authentication enabled
    • Inbound and outbound signing enabled
    • Receipts not enabled or set to asynchronous
    Note: The conformance policy can have all or any of the preceding settings.

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

    • To specify an existing conformance policy, click Select.
    • 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, do 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 assigned by a standards organization, 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.

    Example of a service is urn:example.org:services:CatalogUpdates.
    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.

    Example of a service type is, NewProductUpdates.
    Agreement URI Optional: Type the URI of the location of the agreement (related to the p-mode parameter configuration and operation) between your organization and the partner. The URI must be agreed on by both the partners.

    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 inbound two-way push pull exchange profile, the owner organization is the consumer or responder to the message that is sent by the trading partner.
    Owner role Optional: The owner role is specified by default. To customize the role, remove the default role and enter a new one.
    Receiver ID Optional: 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 to.

    It is recommended that the value of the receiver ID type be an URI. For example, urn:oasis:names:tc:ebxmlcppa: partyid-type: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 inbound exchange profile, the trading partner is the initiator or producer of the message.

    To create a new trading partner organization, click New Organization.

    Alternatively, you can select Anonymous Partner for authentication and authorization, instead of configuring a partner organization in the system. The anonymous partner allows you to represent more than one partner through the anonymous partner mechanism. This mechanism supports many trading partners (or individual users) without needing to configure an organization (identity representation in the system), specific certificates, and exchange details for each one.
    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.
    Sender ID Optional: Click New and type a sender ID. The sender ID is the unique business identifier that is used to identify the trading partner. The identifier is mutually agreed on between your organization and the trading partner.

    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:ebxmlcppa: partyid-type:duns. However, the type can be any text or term that is mutually agreed on with the partner.
  7. Click Inbound Push Request and specify Trigger and Action settings for the inbound push request.
    1. In the Trigger section, specify the AS4 receiver that receives the message from the trading partner and the connection settings for the inbound push request. The AS4 receiver receives the message when the conditions specified in the connection settings are conformed.
    2. In the Action section, specify the messaging destination where the message that is received is unpacked and sent. The business application picks the unpacked message (payload, business document object (BDO), and attachments for processing from the specified messaging destination.
    Field Description
    Select Receiver Click Select and select the AS4 receiver that can receive the message.

    To select a different AS4 receiver, click Remove and select a new receiver.

    To create a new AS4 receiver, click New AS4 Receiver.
    Connection Settings For information about configuring connection settings for inbound push request, see Configuring connection settings for inbound push request in an inbound two-way push pull exchange profile.

    To edit the connection settings, click Edit.

    To remove the connection settings, click Remove.
    Select Destination In an inbound flow, the action for the message that is received from the trading partner is to send the unpacked message to a message destination. The business application picks the unpacked message from the message destination for processing.

    Click Select and select the message queue destination where the unpacked message is sent.

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

    To create a message destination, click New Messaging Destination.
  8. Click Inbound Pull Request and specify Trigger and Action settings for the inbound pull request.
    1. In the Trigger section, specify the messaging receiver that receives the response (for the push request) from the business application.
    2. In the Action section, specify the pull destination from where the trading partner system can retrieve the response.
    Field Description
    New Messaging Receiver Click Select and select the messaging receiver that can receive the response from the business application.

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

    To create a new messaging receiver, click New Messaging Receiver.
    Destination Click Select to select a pull destination.

    To create a new pull destination, click New Pull Destination.

    AS4 Microservice picks up the response from the configured messaging receiver, completes ebMS packaging, and stores the response in the pull destination that is specified in the exchange profile.

    For information about configuring connection settings for the pull response, see Configuring connection settings for inbound pull response in an inbound two-way push pull exchange profile.

    To edit the connection settings, click Edit.

    To remove the connection 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.