Scenario: Receiving an AS4 inbound one-way push request

The following scenarios demonstrate two use cases for the AS4 inbound one-way push exchange pattern:

• Your organization (owner organization A) receives promotions about the new products from your trading partner (organization B).
• Your organization (owner organization A) receives (push) updates about the status of the tax returns that were submitted to your trading partner (organization B).

Configuration requirements

The following table provides information about the configuration that is required to complete an AS4 inbound one-way push exchange.

Conformance policy

To configure the conformance policy, you must define the security, error handling, and reception awareness settings.

For information about configuring a conformance policy, see Configuring custom AS4 conformance policies.

Organizations

You must configure owner and trading partner organizations that are participating in the exchange. The owner organization is specified by default from the owner organization in the conformance policy of the exchange profile.

For information about configuring a trading partner organization, see Creating an organization.

Organization credentials

If user name token authentication is enabled, you must configure organization credentials.

For information about configuring a trading partner organization, see Adding organization credentials.

Message queues

A message queue must be configured by a System Administrator. A Master Account Administrator can use the message queue to create an error notification destination. You can also choose to use the default error notification destination.

For information about configuring message queues, see Configuring a message queue.

Trading partner certificates

If signing is enabled for inbound exchanges, the push requests received from the trading partner is signed. You must add the public key of the certificate (shared by the trading partner) to B2B Advanced Communications. The certificate is used to verify and validate the signature of push request.

For information about configuring trading partner certificates, see Adding a trading partner digital certificate.

Owner organization certificates

If user authentication checking with X.509 certificate is enabled, you must add the required certificate alias to B2B Advanced Communications and share the public key with the trading partner.

For information about configuring owner organization certificates, see Adding a private and public key pair digital certificate and Adding a CA digital certificate.

HTTP or HTTPS server

An HTTP or HTTPS server is an endpoint that is associated with an AS2 or AS4 receiver.

For information about configuring an HTTP or HTTPS server, see Configuring an HTTP server or Configuring an HTTPS server

Thread pool

A thread pool is a collection of threads. A thread pool manages the threads in the pool to process the tasks. To handle large volumes of files or large files, you can have a thread pool with more number of threads and associate the thread pool to the AS4 receiver.

For information about configuring thread pools, see Configuring a thread pool.

Retry policy

You must configure appropriate retry policy and associate it with the HTTP or HTTPS destination.

The retry settings that are specified in the retry policy are used when an HTTP or HTTPS destination is not available (down) during the transmission.

For information about configuring a retry policy, see Configuring a retry policy.

AS4 receiver

You must configure an AS4 receiver to receive the push request.

For information about configuring an AS4 receiver, see Configuring an AS4 receiver.

Messaging destination

You must configure the messaging destination where B2B Advanced Communications sends the unpacked message data.

For information about configuring a messaging destination, see Configuring a messaging destination.

Error notification destination

A messaging destination that is used to notify the user of any errors when a push request is processed and submitted to the business application.

For information about configuring a messaging destination, see Configuring a messaging destination.

Storage settings

Required storage settings.

For information about configuring storage settings, see Configuring storage.

The following users permissions are required to complete an AS4 inbound one-way push exchange:

User with Master Account Administrator permissions

A Master Account Administrator can create or configure the following components:

• Conformance policy
• AS4 inbound one-way push exchange profile
• Messaging destination
• Certificate alias (both trading partner certificates and owner organization certificates)
• HTTP or HTTPS server
• AS4 receiver
• Retry policy
• Organization credential
• Trading partner and owner organization

User with System Administrator permissions

A System Administrator can create or configure message queue and thread pools.

Creating a sample AS4 inbound one-way push exchange profile

The following steps describe how to configure an AS4 inbound one-way push exchange profile. For information about other fields that might be used in this configuration, see Configuring an AS4 inbound one-way push exchange profile.

This procedure assumes that the following components are created in B2B Advanced Communications:

• Message queues
• Retry policy
• HTTP or HTTPS server
• Messaging destination - inboundproductpromo_msgdest
• AS4 receiver - inboundproductpromo_as4rcvr
• Participating organizations - Organization A and Organization B
• Organization credentials - inboundproductpromouser and associated with Organization B (trading partner organization)
• Certificate alias of Organization A - orgacertalias (usage - HTTPS client authentication and signing/signature verification)
• Certificate alias of Organization B - orgbcertalias (usage - HTTPS client authentication and signing/signature verification)
• HTTPS destinations - inboundproductpromo_rcptdest, and inboundproductpromo_errordest

To create an exchange profile that can be used to receive product promotions from organization B:

1. Log in to B2B Advanced Communications as a Master Account Administrator.
2. Click Exchanges > Exchange Profiles.
3. On the Exchange Profiles page, click New and select AS4 Inbound.
4. On the New Exchange Profile dialog box, specify values for the following fields and click Save:

   Profile name

   Type inboundstatuscheckprofile as the profile name

   Select the message exchange pattern for the profile

   Select AS4 Inbound One-Way/Push message exchange pattern from the Exchange pattern list.

   Choose a conformance policy

   Select Default EbHandler PMode Conformance Policy.

   Configuration of the Default EbHandler PMode Conformance Policy is as follows:

   1. User authentication is enabled with user name token and X.509 certificate. Password type for user name token authentication is password digest.
   2. Signing is enabled for outbound and inbound exchanges.
   3. Receipts and Retries are configured.
   4. Error reporting to the trading partner, Organization B) and error notification to the business application are configured.

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

   Name

   The name, inboundproductpromoprofile, that you entered in the Profile name field is populated here.

   Description

   Optional: Enter exchange profile for receiving product promotions

   .

   Service

   Enter product promotion.

   Agreement URI

   Optional: Type http://registry.example.com/cpa/123456.

   The agreement URI is the location of the agreement (related to the p-mode parameter configuration and operation) between your organization (Organization A) and the partner (Organization B). The URI must be agreed upon by both the partners.

   P-Mode ID

   Optional: Type productpromotionpmodeID

   The mutually agreed on p-mode ID is used to identify the p-mode configuration of the conformance policy.

6. Click Participating Organizations to specify the participating organizations:

   Owner Organization

   The owner organization is specified by default from the owner organization in the conformance policy of the exchange profile.

   Receiver ID

   Click New and type orgA.

   Trading Partner Organization

   Click Select and select Organization B.

   Sender ID

   Click New and type orgB.

7. Click Inbound Push Request and specify Trigger and Action settings for the inbound push request:

   Receiver

   Click Select and select inboundproductpromo_as4rcvr to receive inbound push request.

   Configure settings

   Click Configure to configure connection settings for the inbound push request:

   1. Authorization - Select Enable user authorization and select Select list of allowe user subjects. Click Select and select inboundproductpromouser.
   2. Signature - Select Verify usingthe configured certificate, and select orgbcertalias.
   3. ebMS Receipt processing destination - Select inboundproductpromo_rcptdest.
   4. Send ebMS error messages asynchronously to this HTTPS destination - Select inboundproductpromo_errordest.
   5. Click OK to save the connection settings.

   Destination

   Click Select and select inboundproductpromo_msgdest to send unpacked push request.

8. In the Deploy Exchange Profile section, click Deploy to deploy or enable the exchange profile.

   Remember: The Deploy button is enabled only when all the sections of the exchange profile are in Complete status.

Using an AS4 inbound one-way push exchange profile to receive a push request

The following list describes the steps that are involved in receiving a push request from organization B (trading partner):

1. The AS4 receiver (inboundproductpromo_as4rcvr) that is configured in Inbound Push Request section of the exchange profile receives a push request from organization B. The push request is an ebMS message that consists of the payload and attachments.
2. The message service handler (MSH) unpacks the ebMS message and sends the unpacked message to the messaging destination (inboundproductpromo_msgdest) that is specified in the inbound exchange profile.
3. The AS4 receiver sends an HTTP 200 OK message to the sending B2B Advanced Communications (organization B). Based on the reception awareness configuration (in the conformance policy), the AS4 receiver might send a receipt (eb:Signal message) to inboundproductpromo_rcptdest. If any errors are encountered during the processing of the inbound push request, an error message is sent to inboundproductpromo_errordest