String
RosettaNet Connector 2.1 Reference - Mule 4
Anypoint Connector for RosettaNet (Rosettanet Connector) provides B2B functionality that uses the RosettaNet Information Framework (RNIF) for the information exchange of RosettaNet Partner Interface Process (PIP) messages.
Release Notes: RosettaNet Connector Release Notes
Configurations
Configuration for RosettaNet Connector.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
Name of this configuration. Connectors reference the configuration with this name. |
x |
||
Global HTTP Listener |
String |
Reference to the global HTTP Listener definition for the service endpoint used by the partner for action and signal messages. |
x |
|
Service Endpoint Path |
String |
Service endpoint path, appended to the base path of HTTP Listener. |
x |
|
Global HTTP Request |
String |
Global HTTP request definition for the partner service endpoint. This value is used when sending action and signal messages. |
x |
|
Request Endpoint Path |
String |
Partner endpoint path, appended to the base path on an HTTP request. |
x |
|
Keystore path |
String |
Keystore that contains trusted partner certificates and the connector’s private signing key and certificate (JKS format). |
||
Keystore access password |
String |
Access password for the keystore. |
||
Signing key password |
String |
Private signing key password (required if signing action and signal messages). |
||
Override message signing |
Enumeration, one of:
|
Turns message signing on or off. Setting this value to |
||
Global usage code |
Enumeration, one of:
|
Whether to operate in test mode or production mode. |
|
|
Object store reference |
Object Store |
Object store configuration reference:
|
||
Mule DUNS identifier |
String |
DUNS business identifier for the organization. |
x |
|
Mule location identifier |
String |
Location identifier for the organization:
|
||
Partner DUNS identifier |
String |
Expected DUNS business identifier for the partner organization. |
x |
|
Partner location identifier |
String |
Expected location identifier for the partner organization.
|
||
Role in PIP |
Enumeration, one of:
|
Connector’s role in the PIP. |
x |
|
PIP definition path |
String |
PIP file path. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Sources
Action source
<rosetta:action-source>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Streaming Strategy |
Configures how Mule processes streams. By default, Mule uses repeatable streams. |
|||
Redelivery Policy |
Configures a policy for processing the redelivery of the same message. |
Completion source
<rosetta:completion-source>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Primary Node Only |
Boolean |
Whether this source should be executed only on the primary node when running in a cluster. |
||
Redelivery Policy |
Configures a policy for processing the redelivery of the same message. |
Operations
Send Action
<rosetta:send-action>
Transmits the relevant electronic document to a trading partner.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Initiating action |
Lists the reply attributes to send inside the Service header in the MIME message. |
|||
Content |
Binary |
Contents of the business document being exchanged between trading partners. |
|
|
Streaming Strategy |
Configures how Mule processes streams. By default, Mule uses repeatable streams. |
|||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
Object Types
Completion
Completion status and details for the Completion source source.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Completion Code |
Enumeration, one of:
|
Type of completion for the action message. Valid values are:
|
x |
|
Exception Detail |
Details of the received exception signal. Present if the completion code is |
|||
Mime Data |
Binary |
Received MIME signal message provided to the application in support of signed acknowledgment signals. Present if the completion code is |
Exception Detail
Details of the received exception signal.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Exception Code |
String |
Error code. |
x |
|
Exception Error Description |
String |
Error description. |
x |
|
Exception Component Code |
String |
Code that identifies the transaction for which the error occurred. |
x |
|
Exception Type |
String |
Error category. |
x |
Expiration Policy
Configures an expiration policy strategy.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies Max Idle Time. |
Message Attributes
Output of the Action source source, Completion source source, or Send Action operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Message Id |
String |
Unique identifier of the message. |
x |
|
Partner Business Id |
String |
Unique identifier of the trading partner. |
x |
|
Partner Location Id |
String |
Identifier that represents the trading partner’s location. |
x |
|
Reply Attributes |
Identifier values used when generating an action message in reply to another action. The Action source source sets this value. |
x |
||
Mime Data |
Binary |
MIME action or signal message, including the signature, if signing is used. The app supplies this value to support non-repudiation. |
x |
|
Acknowledge Data |
Binary |
MIME acknowledgment signal returned to the sender, including the signature, if signing is used. The Action source source sets this value. |
x |
Non-repeatable Stream
Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
Count |
Number |
How many reconnection attempts to make. |
||
blocking |
Boolean |
If |
|
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
|
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a message can be redelivered and processed unsuccessfully before triggering a |
||
Use Secure Hash |
Boolean |
Whether to use a secure hash algorithm to identify a redelivered message. |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if Use Secure Hash is |
|
|
Id Expression |
String |
One or more expressions that determine when a message was redelivered. This property can be set only if Use Secure Hash is |
||
Object Store |
Object Store |
Configures the object store that stores the redelivery counter for each message. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for Max In Memory Size. |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the maximum buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields. |
Reply Attributes
Configures the values used when generating an action message in reply to another action.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Message Id |
String |
Identifier of the message associated with the reponse. |
x |
|
Action Id |
String |
Identifier that indicates the type of respone. |
x |
|
Pip Instance Id |
String |
Identifier associated with an instance of a PIP. |
x |