This page provides information about the Partner Manager Connector (PMC), including:

Overview

PMC provides connectivity to Anypoint Partner Manager (APM). The connector allows the management of APM-enabled connectors from APM and tracking of B2B exchanges.

Installing the Connector

Follow the steps below to install the PMC in Anypoint Studio.

  1. On the Help menu in Anypoint Studio, select Install New Software…​ to bring up the Available Software dialog box.

  2. Press the Add…​ button, next to the Work with selection box, to add the PMC’s update site. The location for the update site is http://edi-module-update-site.s3.amazonaws.com/beta-updates.

  3. Once added, expand the Premium drop-down and choose Partner Manager Connector.

  4. Click Next >. The Install Details page appears.

  5. Review the details of the item you selected and click Next >.

  6. Accept terms and conditions of the product and press Finish.

  7. Click Restart Now to complete the installation.

Configuring the Connector

  1. Configuration without file persistence

  2. Configuration using Amazon S3 for file persistence

  3. Configuration using a Mule flow for file persistence

Configuration without file persistence

  1. From Anypoint Studio, select the Global Elements view and press Create.

  2. Enter Partner Manager in the filter.

  3. Choose Basic Configuration and click OK.

  4. In the API Key attribute, enter your private API key which is generated from APM portal.

  5. Enter in the Environment ID attribute the CloudHub environment you want PMC to run in.

  6. Press OK.

Configuration using Amazon S3 for file persistence

  1. From Anypoint Studio, select the Global Elements view and press Create.

  2. Enter Partner Manager in the filter.

  3. Choose Amazon S3 File Storage and click OK.

  4. In the API Key attribute, enter your private API key which is generated from APM portal.

  5. Enter in the Environment ID attribute the CloudHub environment you want PMC to run in.

  6. Enter the settings of the S3 bucket to be used for storing files. These settings are obtained from your AWS console.

  7. Press OK.

Configuration using a Mule flow for file persistence

  1. From Anypoint Studio, select the Global Elements view and press Create.

  2. Enter Partner Manager in the filter.

  3. Choose Custom File Storage and click OK.

  4. In the API Key attribute, enter your private API key which is generated from APM portal.

  5. Enter in the Environment ID attribute the CloudHub environment you want PMC to run in.

  6. Type in the name of the flow to be used for persisting files in the Flow Name attribute.

  7. Optionally, inside the File URL attribute, set a MEL expression to read the file URL from the message produced by the flow.

  8. Press OK.

Supported Operations

The connector supports the following operations:

  1. Track Transmission

  2. Track Document

  3. Track Error

  4. Resolve Routes

  5. Start Transactions Replay

  6. End Transactions Replay

  7. Search

  8. Propagate Endpoint Properties

  9. Harvest Endpoint Properties

  10. Harvest Document Properties

  11. Lookup

  12. Update Transaction Status

  13. Retrieve Payload

  14. Get Partnership By Identifiers

  15. Get Events By Transaction ID

  16. Start Errors Notification

  17. End Errors Notification

  18. Evaluate Transaction Release Status

  19. Start Transactions Release

  20. End Transactions Release

Track Transmission

Track transmissions originating from sources other than APM-enabled connectors like the filesystem. User-defined metadata can also be tracked as part of the transmission. The connector expects metadata to be a java.util.Map. Nested maps represent nested metadata. You have the option to define the map inline via the Object Browser, or alternatively, specify from the attribute its location in the Mule message. The reserved key "label" can be used in metadata to label a transmission. A transmission label allows you to easily distinguish between different transmissions in APM portal.

Track Document

Track documents like XML documents. The Document attribute must be set accordingly for APM to inspect the document and perform tasks such as property extraction. User-defined metadata can also be tracked as part of the document. The connector expects metadata to be a java.util.Map. Nested maps represent nested metadata. You have the option to define the map inline via the Object Browser, or alternatively, specify from the attribute its location in the Mule message. The reserved key "label" can be used in metadata to label a document. A document label allows you to easily distinguish between different documents in APM portal.

Track Error

Track errors originating from transactions, documents, transmissions, or business processes. The origin of the error is selected from source attribute and the ID identifying the source is set in the sourceId attribute.

Resolve Routes

Fetch routes that have a source channel matching the document type and transport type. An empty java.util.List is returned if no routes could be found.

Start Transactions Replay

Fetch replayable transactions and set them as replaying. Replaying transactions that have timed out and are identified as such through the Replaying Timeout attribute are included with the result set.

End Transactions Replay

Mark transactions, identified by the given list of transaction IDs, as replayed.

Search

Search a resource with APM’s query language.

Propagate Endpoint Properties

Copy the transmission session’s endpoint properties in the key properties to outbound properties.

Harvest Endpoint Properties

Read the Mule event’s endpoint properties and place them in the transmission session under the key properties.

Harvest Document Properties

Read the Mule event’s document properties and place them in the transmission session under the key properties.

Lookup

Find lookup entries matching the given set of name-value fields and table name. Set the key attribute to ensure no more than a single lookup entry is returned.

Update Transaction Status

Update a transaction’s status to ACTIVE or *INACTIVE.

Retrieve Payload

Fetch a transmission or a document’s raw content from the given URL using the security scheme configured in APM.

Get Partnership By Identifiers

Find a partnership by the partner’s identifier.

Get Events By Transaction ID

Fetches the events (i.e., business document, transmissions, and error) of a transaction given its ID.

Start Errors Notification

Fetches notifiable errors and marks their notification status to NOTIFYING.

End Errors Notification

Marks the notification status of errors, identified by the given list of error IDs, to NOTIFIED.

Evaluate Transaction Release Status

Evaluates if the route has a status window and in that case sets the transaction’s release status to ON HOLD or INACTIVE

Start Transactions Release

Fetches releasable transactions and marks their release status to RELEASING.

End Transactions Release

Marks the release status of transactions, identified by the given list of transaction IDs, to RELEASED.