Nav

Examples

This page identifies examples of Anypoint Partner Manager in use.

For conceptual information, see Key Concepts.

For information about the procedures you would use to implement a given example, see Configure Trading Parners and Transaction Monitoring.

End-to-End Use Case

In this example, a user performs a series of configuration tasks in APM and Anypoint Studio, resulting in the ability to view events and track transmissions.

In APM

  • Enter home organization settings

  • Enter external trading partner settings

In Anypoint Studio

  1. Create your flow.

  2. Configure the Partner Manager Connector.

  3. Configure Partner Manager-enabled connectors to use the Partner Manager Connector.

  4. Use standard MuleSoft connectors and processors to complete the processing and integration of the message into downstream systems as required.

Back in APM

Go to the B2B Transmissions area of APM to view tracked events and messages.

Promotion Scenarios

This section identifies common scenarios for promoting partners from one environment to another. For more information, see Promoting a Partner.

In each of these scenarios, a trading partner P1 has been created in an environment E1. In the table below, that partner is therefore identified as P1E1.
Another partner P1 has been created in environment E2 (P1E2 below). In some scenarios, P1E2 was created by promoting P1E1 from E1 to E2.

In the last scenario, an additional trading partner P2 has been created in environment E2 (P2E2 below).

Scenario Override
Certificates
Checkbox
Keep
Identifiers
Checkbox
Result

P1E1 has previously been promoted to P1E2

Selected

Either selected or not selected

If P1E1 contains any new cerfificates, they will be copied to P1E2

Not Selected

Either selected or not selected

P1E1 will not be copied to P1E2

P1E1 and P1E2 were identical at some point, but a set of identifiers (types and values) has subsequently been configured for AS2, EDI X12 and EDIFACT in P1E1.

Either selected or not selected

Selected

P1E1 identifiers will be copied to P1E2 because the copied data may need information associated with the identifiers (for example Endpoints, or Document Definitions)

Not selected

P1E1 identifiers will be copied to P1E2 because the copied data may need information associated with the identifiers (for example Endpoints, or Document Definitions)

P1E1 and P1E2 were identical at some point, but a set of identifiers (types and values) has subsequently been configured for AS2, EDI X12 and EDIFACT in P1E1 and in addition, E2 has another partner (say, P1E3) that coincidentally has the same identifiers (that is, types & values) as P1E2.

Either selected or not selected

Promotion fails, because having the same set of identifiers (types and values) more than once causes an error.

P1E1 and P1E2 were identical at some point. Subsequently, a set of identifiers (types and values) has been configured for AS2, EDI X12 and EDIFACT in P1E1 and a different set of identifiers (types and values) has been configured for AS2, EDI X12 and EDIFACT in P1E2.

Selected

P1E1 values replace P1E2 values.

Not selected

P1E2 values are not replaced.

P1E1 has a set of identifiers (types and values) for AS2, EDI X12 and EDIFACT.
P2E2, for whatever reason, has exactly the same set of identifiers as P1E1.

Either selected or not selected

Promotion fails, because having the same set of identifiers (types and values) more than once (that is, in both P1E2 and P2E2) causes an error.

Tracking Scenarios

This section identifies scenarios in which Anypoint Partner Manager (APM) is useful to track B2B exchanges. A basic knowledge of APM is assumed; see Anypoint Partner Manager for more information.

Replaying an Incomplete Transaction

On the B2B Transactions Page, the Transactions View includes a table in which each row corresponds to a transaction. The first column shows transaction completion status, as follows:

Green checkmark

Indicates a complete transaction.

Red exclamation point ( !)

Indicates a transaction has one or more errors that prevented completion.

After you identify and fix the cause of the error that prevented the transaction from completing, you can use APM to re-run the transaction.

Possible errors include:

  • Server down

  • Dependency (for example, a map or code element) has changed

  • Required data is absent

Only replay transactions after resolving the issue or issues that caused the error.

For more information, see "Transactions View" in Transaction Monitoring.

To Replay a Transaction

  1. Click the row corresponding to the transaction you want to replay.

    For a transaction to be replayable, the second (Replay Status) column must be blank or contain a gray partial circle, but must not contain a blue partial circle.

    A blue Replay button appears in the Top Bar.

  2. Click the blue Replay button

    The button becomes unclickable, and a message that the transaction is being replayed appears in its place.

    Once the transaction has been replayed, the blue replay circle appears in the Replay Status Column of the transaction that you replayed.

  3. To see if the replayed transaction succeeded or failed, click the replayed transaction.

  4. In the Transaction Detail Pane, a link to view replays appears.

    This automatically filters the grid by Transaction ID, so that only transactions that are replays of the original transaction appear.

    If the replayed transaction fails again, repeat this process until the replay completes.

    You can always view a list of all of transactions that have been replayed from a given original transaction by clicking the link in the Transaction Detail Pane of any transaction for which the blue replay circle appears in the Replay Status Column.

    Once the replay succeeds, a green check appears next to the replayed transaction. If you need to continue replaying the transaction, you can do so with the same replay button as before, but you will be alerted with a warning before you can continue. This is to prevent unnecessary replays from happening.

Common Errors

If you see an atypical number of errors of a similar nature, you can review all of them simultaneously.

The Dashboard at the top of the Transaction Monitoring provides a summary of what has happened in a given timeframe (the default is the current day) including how many errors have been detected during that timeframe.

To View Error Information in the Dashboard

  1. Hover over different slices of the Errors Pie Chart to see what types of errors have occurred.

  2. To see information for a given error type, click one of the slices.

    The Error View appears, showing only the error type over which you were hovering.

    This enables you to look for a pattern among these errors that will facilitate a solution to the errors. This is useful when transactions are failing. but you can’t ascertain the solution by just looking at the transactions themselves.

    The navigation buttons at top right enable you to view the transactions with which these errors are associated.

Transport Problem Identification

If you notice that you are getting a large number of errors from a single type of transport, you can sort your transmissions using a filter in combination with the Transmissions View on the Transaction Monitoring. The filter allows you to view a given transport type and see the differences between those that failed and those that succeeded.

You can find additional relevant information in the Transmissions Detail Pane to the right. In the Detail Pane, you can see what happened with individual transactions with which transmissions were involved through a navigation button in the upper corner.

This allows you to follow transactions through their entire cycle, and if necessary replay them through the replay button.

Because consistent navigation is helpful in looking for patterns and correcting errors, many filters persist from view to view. This allows you to look for commonalities across data types.

When a Partner Needs Records

Often, a partner requires specific information relating to a transaction, transmission, or document. The following explains ways to access and use that information.

Finding Transmissions

  1. On View Dropdown List of the B2B Transactions Page, choose Transmissions.

    The Transmissions View appears.

  2. In the Transmission ID filter, enter the partner ID.

    The Transmissions Detail Pane populates with information that is likely relevant the partner’s request.

  3. To copy a long string for partner use, click the copy button to the right of the string.

    Additional relevant information can be found using the various filter and sort possibilities this view presents.

    You can always use the Clear Filters button to get back to the full view.

    If you need to find out more information about a transmission or just where it exists in the larger scope you can click on the Transaction button in the upper right corner to view the transmission in context.

Finding Documents

  1. On View Dropdown List of the B2B Transactions Page, choose Documents.

    The Documents View appears.

  2. In the Document ID filter, enter the Document ID that the partner provided you.

    The Document Detail Pane populates with information that is likely relevant to the partner’s request.

    To copy a long string for partner use, click the copy button to the right of the string.

    Additional relevant information can be found using the various filter and sort possibilities this view presents.

    You can always use the Clear Filters button to get back to the full view.

    If you need to find out more information about a document, or to see where it fits into the bigger picture, you can click on the Transaction button in the upper right corner to view the document in context.