Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.5.0 or higher

Configs

Custom File Storage

<partner-manager:config-file-storage-custom>

Configuration

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

flowName

String

Name of flow persisting the file.

x 

fileUrl

String

File URL saved to Anypoint Partner Manager. If a MEL expression is set, then the expression is applied to the Mule event returned by the called flow.

 

apiKey

String

Your secret API key granting you access to Anypoint Partner Manager.

x 

tpmServiceAddress

String

Trading Partner Management Service URL for retrieving settings.

https://anypoint.mulesoft.com/b2b/tpm/api

 

trackerAddress

String

Tracker URL for recording transmissions.

https://anypoint.mulesoft.com/b2b/tracker/api

 

environmentId

String

Anypoint Platform environment to operate in.

x 

asynchronousMode

Boolean

Whether tracking is synchronous or asynchronous.

false

 

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

 

maxTotalConnections

Integer

Maximum allowed number of open connections to each Partner Manager service

16

 

Basic Configuration

<partner-manager:config>

Configuration

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

apiKey

String

Your secret API key granting you access to Anypoint Partner Manager.

x 

tpmServiceAddress

String

Trading Partner Management Service URL for retrieving settings.

https://anypoint.mulesoft.com/b2b/tpm/api

 

trackerAddress

String

Tracker URL for recording transmissions.

https://anypoint.mulesoft.com/b2b/tracker/api

 

environmentId

String

Anypoint Platform environment to operate in.

x 

asynchronousMode

Boolean

Whether tracking is synchronous or asynchronous.

false

 

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

 

maxTotalConnections

Integer

Maximum allowed number of open connections to each Partner Manager service

16

 

Amazon S3 File Storage

<partner-manager:config-file-storage-amazon-s3>

Configuration

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

accessKeyId

String

x 

secretKey

String

x 

bucketName

String

x 

region

String

x 

apiKey

String

Your secret API key granting you access to Anypoint Partner Manager.

x 

tpmServiceAddress

String

Trading Partner Management Service URL for retrieving settings.

https://anypoint.mulesoft.com/b2b/tpm/api

 

trackerAddress

String

Tracker URL for recording transmissions.

https://anypoint.mulesoft.com/b2b/tracker/api

 

environmentId

String

Anypoint Platform environment to operate in.

x 

asynchronousMode

Boolean

Whether tracking is synchronous or asynchronous.

false

 

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

 

maxTotalConnections

Integer

Maximum allowed number of open connections to each Partner Manager service

16

 

Processors

Track transmission

<partner-manager:track-transmission>

Track transmission.

XML Sample

<partner-manager:track-transmission config-ref="config" direction="INBOUND" fromPartyIdentifier="PARTNER" toPartyIdentifier="HOME"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

partnerIdentifier

String

Identifier of receiving/sending partner.

x 

direction

Direction

Whether the transmission is incoming or outgoing.

x 

filename

String

Filename for file-based content.

 

metadata

Map<String,Serializable>

Data about the content.

 

transport

String

Transport carrying the transmission.

x 

file

Object

File to pass to file storage provider. The file is required to be one of the following Java types: InputStream, Serializable, or ByteArrayOutputStream. A Partner Manager Connector file storage provider config (e.g., config-file-storage-amazon-s3) must be configured in order to save the file.

 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from the flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Propagate endpoint properties

<partner-manager:propagate-endpoint-properties>

Copy endpoint properties found in the transmission session to outbound properties.

XML Sample

<partner-manager:propagate-endpoint-properties config-ref="config"
                                               endpointName="Bar" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

endpointName

String

Name identifying the send endpoint where the property definitions are defined.

x 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from the flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Harvest endpoint properties

<partner-manager:harvest-endpoint-properties>

Harvest endpoint properties.

XML Sample

<partner-manager:harvest-endpoint-properties config-ref="config"
                                             endpointName="Foo" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

endpointName

String

Name identifying the receive endpoint where the property definitions are defined.

x 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from the flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Harvest document properties

<partner-manager:harvest-document-properties>

Harvest document properties.

XML Sample

<partner-manager:harvest-document-properties config-ref="config" direction="INBOUND"
                                             partnerIdentifier="Big-Retailer" document-ref="#[payload]" standard="OTHER"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

partnerIdentifier

String

Identifier of receiving/sending partner.

 

direction

Direction

Whether the document is incoming or outgoing.

x 

standard

Standard

Document's standard.

OTHER

 

version

String

Document's version.

 

messageType

String

Document's message type.

 

document

Object

Processable document.

 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Track document

<partner-manager:track-document>

Track document.

XML Sample

<partner-manager:track-document config-ref="config" direction="INBOUND"
                                partnerIdentifier="Big-Retailer" document-ref="#[payload]" standard="OTHER"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

partnerIdentifier

String

Identifier of receiving/sending partner.

 

direction

Direction

Whether the document is incoming or outgoing.

x 

filename

String

Filename for file-based content.

 

metadata

Map<String,Object>

 

standard

Standard

Document's standard.

OTHER

 

version

String

Document's version.

 

messageType

String

Document's message type.

 

file

Object

File to pass to file storage provider. The file is required to be one of the following Java types: InputStream, Serializable, or ByteArrayOutputStream. A Partner Manager Connector file storage provider config (e.g., config-file-storage-amazon-s3) must be configured in order to save the file.

 

document

Object

Processable document.

 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Track error

<partner-manager:track-error>

Track error.

XML Sample

<partner-manager:track-error config-ref="config" partnerIdentifier="Big-Retailer" direction="INBOUND"
                             sourceId="#[flowVars.b2bTransmissionSession.transactionId]"
                             message="Something bad happened" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

partnerIdentifier

String

Identifier of receiving/sending partner.

x 

direction

Direction

Whether the error occurred while sending or receiving.

x 

source

Source

Error's origin.

x 

sourceId

String

Source ID.

x 

code

Integer

Error code.

 

message

String

Message describing the error.

 

notified

Boolean

 

transmissionSession

Object

Transaction session to use. By default, the connector tries to read the transaction session from flow variable b2bTransmissionSession. If not found, a new transaction session is created.

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

MuleEvent

Transaction session.

Search

<partner-manager:search>

Search resource.

XML Sample

<partner-manager:search config-ref="config" query="endpointType=='RECEIVE'" resource="ENfaultDPOINT"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

resource

Resource

Resource type to search for.

x 

query

String

Query criteria expressed in PMQL.

x 

count

Integer

Maximum number of objects allowed in the result. No more than 500 objects can be returned at any given time.

200

 

offset

Integer

Return results from a given offset. Default is 0.

0

 

orderBy

String

Sort results by a given field name.

 

descending

Boolean

Sort results by descending or ascending order. Default is descending.

true

 

Returns

Return Java Type Description

Map<String,Serializable>

Query result.

Lookup

<partner-manager:lookup>

Lookup entries.

XML Sample

<partner-manager:lookup config-ref="config"
                        lookupTable="Country Code">
    <partner-manager:fields>
        <partner-manager:field key="country">United States</partner-manager:field>
    </partner-manager:fields>
</partner-manager:lookup>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

lookupTable

String

Name identifying the lookup table where the search for entries is performed.

x 

key

String

Name identifying the lookup key which may be specified in order to enforce field validation and ensure only a single entry is returned.

 

fields

Map<String,Serializable>

Field name-value pairs specifying the entries to search for in the lookup table.

x 

Returns

Return Java Type Description

List<Map<String,Serializable>>

Lookup entries.

Start transactions replay

<partner-manager:start-transactions-replay>

Fetch replayable transactions and set them as replaying.

XML Sample

<partner-manager:start-transactions-replay replayingTimeout="5" config-ref="config"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

replayingTimeout

Integer

Include replaying transactions in the result exceeding the replaying timeout in seconds.

 

Returns

Return Java Type Description

List<Map<String,Serializable>>

Replayable transactions.

End transactions replay

<partner-manager:end-transactions-replay>

Set given transactions as replayed.

XML Sample

<partner-manager:end-transactions-replay config-ref="config">
    <partner-manager:transaction-ids>
        <partner-manager:transaction-id>6c155ed8-cc51-4c6b-b2b7-8355e40fa53a</partner-manager:transaction-id>
        <partner-manager:transaction-id>d8c8cdcb-c91b-4b2b-a16a-7a2a67908db8</partner-manager:transaction-id>
        <partner-manager:transaction-id>f655b3f4-4e13-41b5-a1c6-d267c6b6d373</partner-manager:transaction-id>
    </partner-manager:transaction-ids>
</partner-manager:end-transactions-replay>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

transactionIds

List<String>

List of transaction IDs to be marked as replayed

x 

Resolve routes

<partner-manager:resolve-routes>

Resolve routes.

XML Sample

<partner-manager:resolve-routes config-ref="config" fromPartyIdentifier="MuleSoft"
                                toPartyIdentifier="ModusBox"
                                partyIdentifierType="PARTNER" standard="EDIFACT"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fromPartyIdentifier

String

Identifier of sending party.

x 

toPartyIdentifier

String

Identifier of receiving party.

 

partyIdentifierType

PartyIdentifierType

Type of identifier.

 

standard

Standard

Document's standard.

x 

version

String

Document's version.

 

messageType

String

Document's message type.

 

transmissionSession

Object

#[flowVars.b2bTransmissionSession]

 

Returns

Return Java Type Description

List<Map<String,Serializable>>

List of routes.

Update transaction status

<partner-manager:update-transaction-status>

Updates the status of a transaction.

XML Sample

<partner-manager:update-transaction-status config-ref="config" status="COMPLETE"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

transactionId

String

ID identifying the transaction to be updated. transactionId overrides the transaction ID read from b2bTransmissionSession.

 

status

Status

Transaction status to update to.

x 

transmissionSession

Object

Transaction session to read transaction ID from. By default, the connector tries to read the transaction session from the flow variable b2bTransmissionSession.

#[flowVars.b2bTransmissionSession]

 

Retrieve payload

<partner-manager:retrieve-payload>

Based on URL specified by caller, returns the payload.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

payloadLocation

String

the url to the payload that needs to be treturned

x 

Returns

Return Java Type Description

InputStream

a byte buffer representing the payload in question

Get partnership by identifiers

<partner-manager:get-partnership-by-identifiers>

Gets the Partnership by the given Identifier name.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

partnerIdentifier

String

Identifier of receiving/sending partner.

x 

Returns

Return Java Type Description

Map<String,Serializable>

Query result.

Get events by transaction id

<partner-manager:get-events-by-transaction-id>

Gets all the events by the given Transaction.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

transactionId

String

ID identifying the Transaction.

x 

Returns

Return Java Type Description

List<Map<String,Serializable>>

Query result.

Get error codes

<partner-manager:get-error-codes>

Gets all the error codes.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Serializable>>

Query result.

Notify

<partner-manager:notify>

Sets notified field of the given error to true.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

errorId

String

Error to be notified as true

x