Nav

RosettaNet Connector Reference

This is the main class of an extension, and is the entry point from which configurations, connection providers, operations, and sources are declared.

Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Global HTTP Listener

String

Reference to a global HTTP Listener definition for the service endpoint used by a partner for both action and signal messages.

x

Service Endpoint Path

String

Service endpoint path, appended to the base path in the HTTP Listener.

x

Global HTTP Request

String

Reference to a global HTTP Request definition for a partner service endpoint. This is used when sending both action and signal messages.

x

Request Endpoint Path

String

Partner endpoint path, appended to the base path in an HTTP Request.

x

Keystore path

String

Keystore containing trusted partner certificates and your 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:

  • ALWAYS

  • NEVER

Forces message signing on or off (when set, overrides signing configured by a PIP definition).

Global usage code

Enumeration, one of:

  • Test

  • Production

Choose whether operating in Test or Production mode, or if both are allowed.

Production

Object store reference

ObjectStore

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 be used instead.

Mule DUNS identifier

String

DUNS business identifier for this organization.

x

Mule location identifier

String

Location ID for this organization.

x

Partner DUNS identifier

String

Expected DUNS business identifier for partner organization.

x

Partner location identifier

String

Expected location ID for partner organization.

x

Role in PIP

Enumeration, one of:

  • INITIATOR

  • RESPONDER

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 the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime only purges instances as needed.

Associated Operations

Associated Sources

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

#[payload]

Target Variable

String

The name of a variable in which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of that expression is stored in the target variable.

#[payload]

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • ROSETTA:CONFIGURATION

  • ROSETTA:PARSE

  • ROSETTA:UNKNOWN

  • ROSETTA:WRITE

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 only execute 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.

Output

Type

Binary

Attributes Type

For Configurations

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 only execute on the primary node when running in a Cluster.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Output

Type

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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 message, including signature if signing is used. This is supplied to the application to support non-repudiation.

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 to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of Max In Memory Size.

Buffer Size Increment

Number

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 STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

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 on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

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 process-failed-message.

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 SHA-256.

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

ObjectStore

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:

  • SUCCESS

  • FAILURE

  • EXCEPTION

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

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+