String
RosettaNet Connector Reference - Mule 4
RosettaNet Connector Version 2.0.11
This reference provides field information for each operation pf the main class of an extension. This is the entry point from which configurations, connection providers, operations and sources are declared.
Release Notes: RosettaNet Connector Release Notes
Default Configurations
Configurations
The defaults for configurations and operations.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
The name for this configuration. Connectors reference the configuration with this name. |
x |
||
Global HTTP Listener |
String |
Reference to the global HTTP Listener definition for our service endpoint used by partner for both action and signal messages. |
x |
|
Service Endpoint Path |
String |
Service endpoint path, appended to base path on HTTP Listener. |
x |
|
Global HTTP Request |
String |
Reference to the global HTTP Request definition for partner service endpoint used when sending both action and signal messages. |
x |
|
Request Endpoint Path |
String |
Partner endpoint path, appended to base path on HTTP Request. |
x |
|
Keystore path |
String |
Keystore containing trusted partner certificates and our own private signing key and certificate (JKS format). |
||
Keystore access password |
String |
Keystore access password. |
||
Signing key password |
String |
Private signing key password (required if signing either action or signal messages). |
||
Override message signing |
Enumeration, one of:
|
Force message signing on or off (when set, overrides signing configured by PIP definition). |
||
Global usage code |
Enumeration, one of:
|
Choose whether operating in Test or Production mode, or if both allowed. |
Production |
|
Object store reference |
Object Store |
Object store configuration reference. If not set the connector always uses the default persistent object store to retain sent messages waiting for acknowledgments or retries. If set, the referenced bean must be an object store configuration to use instead. |
||
Mule DUNS identifier |
String |
DUNS business identifier for this organization. |
x |
|
Mule location identifier |
String |
Location ID for this organization. If specified, this value is included in all messages sent and verified in all messages received. If not specified no value is sent and received values are ignored. |
||
Partner DUNS identifier |
String |
Expected DUNS business identifier for partner organization. |
x |
|
Partner location identifier |
String |
Expected location ID for partner organization. If specified, this value is included in all messages sent and verified in all messages received. If not specified no value is sent and received values are ignored. |
||
Role in PIP |
Enumeration, one of:
|
Our role in PIP usage. |
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. |
Operations
Send Action
<rosetta:send-action>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Initiating action |
||||
Content |
Binary |
|
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and stores the expression outcome in the target variable. |
|
Sources
Action Source
<rosetta:action-source>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The 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. |
||
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
Completion Source
<rosetta:completion-source>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The 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 |
Defines a policy for processing the redelivery of the same message. |
Types
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute. |
Message Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Message Id |
String |
Action message identifier. |
x |
|
Partner Business Id |
String |
x |
||
Partner Location Id |
String |
x |
||
Reply Attributes |
Identifier values used when generating an action message in reply to some other action. This is only set by the Action Source. |
x |
||
Mime Data |
Binary |
MIME action or signal message, including signature if signing is used. This is supplied to the application in order to support non-repudiation. |
x |
|
Acknowledge Data |
Binary |
MIME acknowledgment signal returned to sender, including signature if signing is used. This is only set by the ActionSource. |
x |
Reply Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Message Id |
String |
x |
||
Action Id |
String |
x |
||
Pip Instance Id |
String |
x |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content onto disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which |
Redelivery Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
The maximum number of times a message can be redelivered and processed unsuccessfully before triggering |
||
Use Secure Hash |
Boolean |
Whether to use a secure hash algorithm to identify a redelivered message. |
||
Message Digest Algorithm |
String |
The secure hashing algorithm to use. If not set, the default is |
||
Id Expression |
String |
Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. |
||
Object Store |
Object Store |
The object store where the redelivery counter for each message is going to be stored. |
Completion
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Completion Code |
Enumeration, one of:
|
Type of completion for action message. SUCCESS means an Acknowledgment signal was received from the partner; EXCEPTION means an Exception signal was received from the partner; FAILURE means no response signal was received from the partner after the number of transmission attempts defined in the PIP configuration. |
x |
|
Exception Detail |
Details from received Exception signal. This is only present if the completion code is EXCEPTION. |
|||
Mime Data |
Binary |
Received MIME signal message, provided to the application in support of signed Acknowledgment signals. This is only present for completion codes of SUCCESS or EXCEPTION. |
Exception Detail
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Exception Code |
String |
x |
||
Exception Error Description |
String |
x |
||
Exception Component Code |
String |
x |
||
Exception Type |
String |
x |