Partner Manager Connector API Reference

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

flowName

Name of flow persisting the file.

fileUrl

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

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

tpmServiceAddress

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

Trading Partner Management Service URL for retrieving settings.

trackerAddress

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

Tracker URL for recording transmissions.

environmentId

Anypoint Platform environment to operate in.

enableCaching

Enable caching

false

cacheMaxExportTries

Maximum number of times to wait for export before giving up

cacheRefreshIntervalMinutes

How long to wait before refreshing the local cache

asynchronousMode

Whether tracking is synchronous or asynchronous.

false

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

maxTotalConnections

Maximum allowed number of open connections to each Partner Manager service

connectTimeoutMs

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

connectionRequestTimeoutMs

Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

socketTimeoutMs

Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

5000

maxNumberOfRetries

Maximum number of times a failed HTTP request is retried

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
enableCaching	Boolean	Enable caching	false
cacheMaxExportTries	Integer	Maximum number of times to wait for export before giving up	30
cacheRefreshIntervalMinutes	Integer	How long to wait before refreshing the local cache	15
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
connectTimeoutMs	Integer	Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.	5000
connectionRequestTimeoutMs	Integer	Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.	5000
socketTimeoutMs	Integer	Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).	5000
maxNumberOfRetries	Integer	Maximum number of times a failed HTTP request is retried	3

Name

Java Type

Description

Default Value

Required

name

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

apiKey

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

tpmServiceAddress

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

Trading Partner Management Service URL for retrieving settings.

trackerAddress

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

Tracker URL for recording transmissions.

environmentId

Anypoint Platform environment to operate in.

enableCaching

Enable caching

false

cacheMaxExportTries

Maximum number of times to wait for export before giving up

cacheRefreshIntervalMinutes

How long to wait before refreshing the local cache

asynchronousMode

Whether tracking is synchronous or asynchronous.

false

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

maxTotalConnections

Maximum allowed number of open connections to each Partner Manager service

connectTimeoutMs

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

connectionRequestTimeoutMs

Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

socketTimeoutMs

Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

5000

maxNumberOfRetries

Maximum number of times a failed HTTP request is retried

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
enableCaching	Boolean	Enable caching	false
cacheMaxExportTries	Integer	Maximum number of times to wait for export before giving up	30
cacheRefreshIntervalMinutes	Integer	How long to wait before refreshing the local cache	15
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
connectTimeoutMs	Integer	Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.	5000
connectionRequestTimeoutMs	Integer	Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.	5000
socketTimeoutMs	Integer	Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).	5000
maxNumberOfRetries	Integer	Maximum number of times a failed HTTP request is retried	3

Name

Java Type

Description

Default Value

Required

name

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

accessKeyId

secretKey

bucketName

region

apiKey

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

tpmServiceAddress

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

Trading Partner Management Service URL for retrieving settings.

trackerAddress

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

Tracker URL for recording transmissions.

environmentId

Anypoint Platform environment to operate in.

enableCaching

Enable caching

false

cacheMaxExportTries

Maximum number of times to wait for export before giving up

cacheRefreshIntervalMinutes

How long to wait before refreshing the local cache

asynchronousMode

Whether tracking is synchronous or asynchronous.

false

queueManager

QueueManager

Queue Manager to use for asynchronous tracking

maxTotalConnections

Maximum allowed number of open connections to each Partner Manager service

connectTimeoutMs

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

connectionRequestTimeoutMs

Returns the timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined.

5000

socketTimeoutMs

Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

5000

maxNumberOfRetries

Maximum number of times a failed HTTP request is retried

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.
priority	Integer	Priority for the transaction (e.g values from 1 to 5 inclusive)
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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

partnerIdentifier

Identifier of receiving/sending partner.

direction

Direction

Whether the transmission is incoming or outgoing.

filename

Filename for file-based content.

metadata

Map<String,Serializable>

Data about the content.

transport

Transport carrying the transmission.

file

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.

priority

Priority for the transaction (e.g values from 1 to 5 inclusive)

transmissionSession

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.

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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

endpointName

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

transmissionSession

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.

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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

endpointName

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

transmissionSession

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.

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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

partnerIdentifier

Identifier of receiving/sending partner.

direction

Direction

Whether the document is incoming or outgoing.

standard

Standard

Document's standard.

OTHER

version

Document's version.

messageType

Document's message type.

document

Processable document.

transmissionSession

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.

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>	Data about the content.
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.
priority	Integer	Priority for the transaction (e.g values from 1 to 5 inclusive
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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

partnerIdentifier

Identifier of receiving/sending partner.

direction

Direction

Whether the document is incoming or outgoing.

filename

Filename for file-based content.

metadata

Map<String,Object>

Data about the content.

standard

Standard

Document's standard.

OTHER

version

Document's version.

messageType

Document's message type.

file

document

Processable document.

priority

Priority for the transaction (e.g values from 1 to 5 inclusive

transmissionSession

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.

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	true if the error was notified
priority	Integer	Priority for the transaction (e.g values from 1 to 5 inclusive
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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

partnerIdentifier

Identifier of receiving/sending partner.

direction

Direction

Whether the error occurred while sending or receiving.

source

Source

Error's origin.

sourceId

Source ID.

code

Error code.

message

Message describing the error.

notified

true if the error was notified

priority

Priority for the transaction (e.g values from 1 to 5 inclusive

transmissionSession

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.

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.
count	Integer	Maximum number of objects allowed in the result. No more than 200 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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

resource

Resource

Resource type to search for.

query

Query criteria expressed in PMQL.

count

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

200

offset

Return results from a given offset. Default is 0.

orderBy

Sort results by a given field name.

descending

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

true

Returns

Return Java Type	Description
List<Map<String,Serializable>>	Query result.

Return Java Type

Description

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	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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

lookupTable

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

key

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.

Returns

Return Java Type	Description
List<Map<String,Serializable>>	Lookup entries.

Return Java Type

Description

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.

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

replayingTimeout

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

Returns

Return Java Type	Description
List<Map<String,Serializable>>	Replayable transactions.

Return Java Type

Description

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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

transactionIds

List<String>

List of transaction IDs to be marked as replayed

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	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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

fromPartyIdentifier

Identifier of sending party.

toPartyIdentifier

Identifier of receiving party.

partyIdentifierType

PartyIdentifierType

Type of identifier.

standard

Standard

Document's standard.

version

Document's version.

messageType

Document's message type.

transmissionSession

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
List<Map<String,Serializable>>	List of routes.

Return Java Type

Description

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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

transactionId

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

status

Status

Transaction status to update to.

transmissionSession

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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

payloadLocation

the url to the payload that needs to be treturned

Returns

Return Java Type	Description
InputStream	a byte buffer representing the payload in question

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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

partnerIdentifier

Identifier of receiving/sending partner.

Returns

Return Java Type	Description
Map<String,Serializable>	Query result.

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 ID.

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
transactionId	String	ID identifying the transaction.		x

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

transactionId

ID identifying the transaction.

Returns

Return Java Type	Description
List<Map<String,Serializable>>	Query result.

Return Java Type

Description

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

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

errorId

Error to be notified as true

Start errors notification

<partner-manager:start-errors-notification>

Fetch notifiable errors and set them as notifying.

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
notifyingTimeout	Integer	Include notifying errors in the result exceeding the notifying timeout in seconds.

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

notifyingTimeout

Include notifying errors in the result exceeding the notifying timeout in seconds.

Returns

Return Java Type	Description
List<Map<String,Serializable>>	Notifiable errors.

Return Java Type

Description

Notifiable errors.

End errors notification

<partner-manager:end-errors-notification>

Set given errors as notified.

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
errorIds	List<String>	List of error IDs to be marked as notified		x

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

errorIds

List<String>

List of error IDs to be marked as notified

Evaluate transaction release status

<partner-manager: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

Attributes

Name	Java Type	Description	Default Value	Required
config-ref	String	Specify which config to use		x
routeId	String	the route to evaluate if it has a status window		x
transactionId	String	the transaction for which the release status might change		x
target	String	location to store the release status	#[flowVars.b2bTransmissionSession.releaseStatus]
routeStatus	String	the status of the route received in the resolve routes operation
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]

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

routeId

the route to evaluate if it has a status window

transactionId

the transaction for which the release status might change

target

location to store the release status

#[flowVars.b2bTransmissionSession.releaseStatus]

routeStatus

the status of the route received in the resolve routes operation

transmissionSession

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	the MuleEvent

Return Java Type

Description

MuleEvent

the MuleEvent

Start transactions release

<partner-manager:start-transactions-release>

Fetch releasable transactions and set them as releasing.

Attributes

Name	Java Type	Description	Required
config-ref	String	Specify which config to use	x
releasingTimeout	Integer	Include releasing transactions in the result exceeding the releasing timeout in seconds.
maxTransactions	Integer

Name

Java Type

Description

Default Value

Required

config-ref

Specify which config to use

releasingTimeout