Contact Us 1-800-596-4880
  1. Homepage
  2. TRADACOMS EDI Connector (3.0)

  3. TRADACOMS EDI Connector Reference

All Connectors

TRADACOMS EDI Connector 3.0 Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

None

None

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This doesn’t mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances as it sees fit.

None

None

Schema definitions

Array of String

List of paths for schemas that the module uses. The paths can be for the file system or the classpath.

None

None

Partner Code

String

Code used to identify the partner. If you specify this value, it’s used to validate the Transmission Sender Code in received transmissions and to set the Transmission Recipient Code in sent transmissions (if map data doesn’t specify it). If you don’t specify this value, the Transmission Sender Code isn’t checked in received transmissions.

None

None

Partner Name

String

Name used to identify the partner. If you specify this value, it’s used to validate the Transmission Sender Name in received transmissions and to set the Transmission Recipient Name in sent transmissions (if map data doesn’t specify it). If you don’t specify this value, the Transmission Sender Name isn’t checked in received transmissions.

None

None

Mule Code

String

Code used to identify the Mule app. If you specify this value, it’s used to validate the Transmission Recipient Code in received transmissions and to set the Transmission Sender Code in sent transmissions (if map data doesn’t specify it). If you don’t specify this value, the Transmission Recipient Code isn’t checked in received transmissions.

None

None

Mule Name

String

Name used to identify the Mule app. If you specify this value, it’s used to validate the Transmission Recipient Name in received transmissions and to set the Transmission Sender Name in sent transmissions (if map data doesn’t specify it). If you don’t specify this value, the Transmission Recipient Name isn’t checked in received transmissions.

None

None

Enforce length limits

Boolean

Enforce minimum and maximum lengths for receive values. If true, a transmission with values that are too long or too short is rejected. If false, the values are used and the transmission isn’t rejected. In either case the error is logged and included in the error list.

true

None

Allow unknown segments

Boolean

Allow unknown segments in a message. If false, a transmission containing any unknown segments is rejected. If true, unknown segments are ignored and the transmission isn’t rejected. In either case the error is logged and included in the error list.

false

None

Allow unused segments

Boolean

Allow segments marked as 'Unused' in a message. If false, a message containing segments marked as unused in the schema is rejected. If true, the message isn’t rejected and the unused segments are ignored. In either case the error is reported in CONTRL functional acknowledgments.

true

None

Enforce segment order

Boolean

Enforce segment order in a message. If true, a message with segments out of order is rejected. If false and the segment can be reordered, the message isn’t rejected. In either case the error is reported in CONTRL functional acknowledgments.

true

None

Transmission Reference

String

Default Sender’s Transmission Reference used when writing a transmission. If specified, this value is used as a default if the required Sender’s Transmission Reference value is not specified in map data for a send transmission (write operation).

None

None

Recipient Reference

String

Default Recipient’s Transmission Reference used when writing a transmission. If specified, this value is used as a default if an optional Recipient’s Transmission Reference value is not specified in map data for a send transmission (write operation).

None

None

Application Reference

String

Default Application Reference used when writing a transmission. If specified, this value is used as a default if an optional Application Reference value is not specified in map data for a send transmission (write operation).

None

None

Priority Code

String

Default Transmission Priority Code used when writing a transmission. If specified, this value is used as a default if an optional Transmission Priority Code value is not specified in map data for a send transmission (write operation).

None

None

Associated Operations

  • read

  • write

Read

<tradacoms:read>

Transforms an EDI text input stream into a structure of maps and lists.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

None

None

Read Content

Binary

#[payload]

None

Target Variable

String

Name of the variable that stores the operation output.

None

None

Target Value

String

Expression that’s evaluated against the operation output. The outcome is stored in the target variable.

#[payload]

None

Output

Type

Object

For Configurations

  • config

Throws

  • TRADACOMS:UNKNOWN

  • TRADACOMS:SCHEMA

  • TRADACOMS:PARSE

  • TRADACOMS:WRITE

Write

<tradacoms:write>

Transforms a maps-and-lists structure of EDI data into an EDI text stream.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

None

None

Write Content

Object

#[payload]

None

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configures whether to use repeatable streams and how they behave.

None

None

Target Variable

String

Name of the variable that stores the operation output.

None

None

Target Value

String

Expression that’s evaluated against the operation output. The outcome is stored in the target variable.

#[payload]

None

Output

Type

Binary

For Configurations

  • config

Throws

  • TRADACOMS:UNKNOWN

  • TRADACOMS:SCHEMA

  • TRADACOMS:PARSE

  • TRADACOMS:WRITE

Types

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

Maximum time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

None

None

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the maxIdleTime attribute.

None

None

Repeatable In-Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

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, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

None

None

Buffer Size Increment

Number

How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer doesn’t expand. When the buffer gets full, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised.

None

None

Max Buffer Size

Number

Maximum amount of memory used. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value of zero or less means no limit.

None

None

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

None

None

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Maximum memory that the stream uses to keep data in memory. If more than that is consumed, the stream starts to buffer the content on disk.

None

None

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

None

None

See Also

Salesforce Help

Back to top