Name |
String |
ID used to reference this configuration. |
|
x |
Expiration Policy |
ExpirationPolicy |
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 instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate. |
|
|
Mule interchange ID |
String |
Identification for the Mule app in the exchange (UNB segment). This value is used in combination with the value of the Mule ID qualifier field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNB interchange recipient identification must match this value.
-
On the send side, the connector uses this value as the UNB interchange sender identification unless it is overridden in the message parameters.
|
|
|
Mule ID qualifier |
String |
Identification qualifier for the Mule app in the exchange (UNB segment). This value is used in combination with the value of the Mule interchange ID field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNB interchange recipient identification code qualifier must match this value.
-
On the send side, the connector uses this value as the UNB interchange sender identification code qualifier unless it is overridden in either the send configuration or the message parameters.
|
|
1 |
Mule application sender/recipient ID |
String |
Identification for the Mule app in the exchange (UNG segment). This value is used in combination with the value of the Mule application sender/recipient ID qualifier field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNG group recipient identification must match this value.
-
On the send side, the connector uses this value as the UNG group sender identification unless it is overridden in the message parameters.
|
|
|
Mule application sender/recipient ID qualifier |
String |
Identification qualifier for the Mule app in the exchange (UNG segment). This value is used in combination with the value of the Mule application sender/recipient ID field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNG group recipient identification code qualifier must match this value.
-
On the send side, the connector uses this value as the UNG group sender identification code qualifier unless it is overridden in either the send configuration or the message parameters.
|
|
|
Partner interchange ID |
String |
Identification for the partner in the exchange (UNB segment). This value is used in combination with the value of the Partner ID qualifier field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNB interchange sender identification must match this value.
-
On the send side, the connector uses this value as the UNB interchange recipient identification code unless it is overridden in either the send configuration or the message parameters.
|
|
|
Partner ID qualifier |
String |
Identification qualifier for the partner in the exchange (UNB segment). This value is used in combination with the value of the Partner Interchange ID field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNB interchange sender identification code qualifier must match this value.
-
On the send side, the connector uses this value as the UNB interchange recipient identification code qualifier unless it is overridden in either the send configuration or the message parameters.
|
|
|
Partner application sender/recipient ID |
String |
Identification for the partner in the exchange (UNG segment). This value is used in combination with the value of the Partner application sender/recipient ID qualifier field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNG group sender identification must match this value.
-
On the send side, the connector uses this value as the UNG group recipient identification code unless it is overridden in either the send configuration or the message parameters.
|
|
|
Partner application sender/recipient ID qualifier |
String |
Identification qualifier for the partner in the exchange (UNG segment). This value is used in combination with the value of the Partner application sender/recipient ID field, and if one field is set, the other must also be set.
If set, this value affects both send and receive message handling:
-
On the receive side, the UNG group sender identification code qualifier must match this value.
-
On the send side, the connector uses this value as the UNG group recipient identification code qualifier unless it is overridden in either the send configuration or the message parameters.
|
|
|
Schema definitions |
Array of String |
List of schema file system paths or class paths for the module to use. |
|
x |
Substitution character |
String |
Substitution character used to replace invalid characters in string values when using syntax level UNOA or UNOB . The use of this substitution character, if set, is controlled by separate parser and writer flags. |
|
|
Separators usage |
-
USE_DEFAULTS
-
USE_SPECIFIED_FOR_WRITES
-
USE_SPECIFIED_FOR_ALL
|
Defines how specified separator and release characters are used:
-
USE_DEFAULTS
Use defaults as defined by EDIFACT syntax version standards.
-
USE_SPECIFIED_FOR_WRITES
Use standard default delimiters for reads and specified delimiters as defaults for writes.
-
USE_SPECIFIED_FOR_ALL
Use specified delimiters as the defaults for both reads and writes.
|
USE_SPECIFIED_FOR_ALL |
|
Data element separator |
String |
Default data element separator character. |
+ |
|
Component element separator |
String |
Component element separator character. |
: |
|
Repetition separator |
String |
Repetition separator character. |
* |
|
Segment terminator |
String |
Segment terminator character. |
' |
|
Release character |
String |
Release character. |
? |
|
Timezone offset |
String |
Time zone offset from the UTC to apply to the date and time elements in the Interchange Header (UNB) segment. This field accepts only values compliant with ISO 8601 (which are UTC-based), for example, -01:00 , +0100 , -0130 , and so on.
If you don’t specify a value for this field, the Interchange Header segment date and times are set to the local time of the Mule runtime. |
|
|
Enforce length limits |
Boolean |
Enforce minimum and maximum lengths for receive values:
-
true
The connector rejects messages with values that are too long or too short.
-
false
The connector uses the values and does not reject the messages.
In either case, the error is logged and reported in CONTRL functional acknowledgments.
|
true |
|
Enforce value repeats |
Boolean |
Enforce repetition count limits for receive values:
-
true
The connector rejects messages that have values repeated too many or too few times.
-
false
The connector uses the values and does not reject the messages.
In either case, the error is reported in CONTRL functional acknowledgments.
|
true |
|
Enforce valid characters |
Boolean |
Enforce valid characters when using syntax levels UNOA and UNOB:
-
true
The connector rejects received messages that contain characters that the syntax level does not allow.
-
false
If a substitution character is set, the connector uses it in place of the disallowed characters. Otherwise, the connector passes the disallowed characters through.
|
true |
|
Allow unknown segments |
Boolean |
Allow unknown segments in a message:
-
true
The connector ignores the unknown segments and does not reject the messages.
-
false
The connector rejects messages that contain unknown segments.
In either case, the error is reported in CONTRL functional acknowledgments.
|
false |
|
Enforce segment order |
Boolean |
Enforce segment order in a message:
-
true
The connect rejects messages that have out-of-order segments.
-
false
The connector does not reject messages if their out-of-order segments can be reordered.
In either case, the error is reported in CONTRL functional acknowledgments.
|
true |
|
Allow unused segments |
Boolean |
Allow segments marked as Unused in the schema:
-
true
The connector ignores unused segments and does not reject the messages.
-
false
The connector rejects messages that contain segments marked as Unused in the schema.
In either case, the error is reported in CONTRL functional acknowledgments.
|
true |
|
Enforce segment repeats |
Boolean |
Enforce segment repetition count limits in a message:
-
true
The connector rejects messages that have a segment repeated too many times.
-
false
The connector does not reject the messages.
In either case, the error is reported in CONTRL functional acknowledgments.
|
true |
|
Character encoding override |
String |
Character encoding override for receive messages, which must be a Java character encoding name. Normally, character encoding is determined by the syntax identifier in the UNB header segment, but the connector uses this value instead, if it is set. |
|
|
Require unique interchanges |
Boolean |
Reject an interchange if the Interchange Control Reference has previously been processed:
-
true
Record the interchange numbers previously processed and reject any duplicate interchange numbers from the same partner, as determined by the interchange sender and receiver identification.
-
false
The application flow tracks the numbers and handles them appropriately.
|
false |
|
Require unique groups |
Boolean |
Reject a group if the group control reference was processed previously:
-
true
Record the group numbers processed previously and reject duplicate group numbers from the same partner, as determined by the interchange sender and receiver identification.
-
false
The application flow tracks the numbers and handles them appropriately.
|
false |
|
Require unique messages |
Boolean |
Enforce globally unique Message Reference Numbers (UNH.1) for received messages:
-
true
Message reference numbers must be unique across all interchanges received from the same partner and application, as determined by the interchange sender and recipient identification.
-
false
Message reference numbers must be unique within a particular interchange.
|
false |
|
Store time-to-live |
Number |
Minimum number of days to store interchange and message numbers in the default persistent object store. This value is used only when the configuration requires unique interchanges, message numbers, or both. It sets the entry time-to-live for these stored values. |
30 |
|
Write character encoding |
-
ASCII_A
-
ASCII_B
-
ISO8859_1
-
ISO8859_2
-
ISO8859_3
-
ISO8859_4
-
ISO8859_5
-
ISO8859_6
-
ISO8859_7
-
ISO8859_8
-
ISO8859_9
-
UTF8
|
Character encoding used for writing messages. |
ASCII_B |
|
Syntax version |
-
VERSION1
-
VERSION2
-
VERSION3
-
VERSION4
|
Syntax version for send messages. This version determines the data structures used for service segments and CONTRL acknowledgment message structures in DataSense metadata for both send and receive messages. The actual message data for receive messages reflects the syntax version used in the received interchange. |
VERSION4 |
|
Segment line ending |
|
Line ending to add between segments. This can improve the readability of the output message text. |
NONE |
|
Always send UNA |
Boolean |
-
true
Always send a UNA service segment.
-
false
Include a UNA in an interchange when the syntax separator characters don’t match the defaults for the syntax version and character encoding in use.
|
false |
|
Enforce valid characters |
Boolean |
Enforce valid characters when using syntax levels UNOA and UNOB.
-
true
The connector rejects received messages that contain characters not allowed by the syntax level.
-
false
The connector either uses a substitution character if one is set, or passes the disallowed characters through.
|
true |
|
Use Functional Groups |
Boolean |
Group messages with the same functional group identifier inside UNG-UNE envelopes:
-
true
Groups messages into UNG-UNE segments.
-
false
Writes all messages in the same interchange.
|
false |
|
Unique group numbers |
Boolean |
Send unique message reference numbers (UNG.5):
-
true
Assigns unique transaction set numbers across all groups sent to the same partner, as determined by the group sender and recipient identification.
-
false
Assigns message reference numbers sequentially within each group and reuses them in different interchanges.
|
false |
|
Unique message numbers |
Boolean |
Send unique Message Reference Numbers (UNH.1):
-
true
Assigns unique transaction set numbers across all interchanges sent to the same partner, as determined by the interchange sender and recipient identification.
-
false
Assigns message reference numbers sequentially within each interchange and reuses them in different interchanges.
|
false |
|
Initial group reference |
String |
The initial group control reference used for outgoing messages. |
1 |
|
Initial interchange reference |
String |
The initial interchange control reference used for outgoing messages. |
1 |
|
Initial message reference |
String |
The initial message reference number used for outgoing messages. |
1 |
|
Request acknowledgments |
Boolean |
Requests acknowledgments for Send interchanges using the Acknowledgment Request field (UNB.9):
-
true
Requests CONTRL acknowledgments in all sent interchanges.
-
false
Requests receipt confirmations.
|
false |
|
Test indicator |
String |
Test indicator digit to use on Send interchanges. By default, interchanges are not sent as tests. |
|
|
Use Supplied Values |
Boolean |
Whether to generate control numbers when writing or use supplied values for control-segment information such as control numbers:
-
true
The connector uses the provided control-segment information.
-
false
The connector automatically generates control numbers when writing.
|
false |
|
Interchange control number key |
String |
Key-value pair of the interchange control key and interchange control number. |
NONE |
|
Message control number key |
String |
Key-value pair of the message control key and message control number. |
NONE |
|
Group control number key |
String |
Key-value pair of the group control key and group control number. |
NONE |
|
Truncate values exceeding the length limits |
Boolean |
Whether to truncate values that exceed the length limits:
-
true
If the Enforce length limits field is also true, the connector trims values that exceed the maximum length.
-
false
The connector writes the values as they are.
|
false |
|
Enforce code set validations |
Boolean |
Whether to enforce code set validations:
-
true
The connector enforces code set validations, as defined in the EDIFACT schemas.
-
false
The connector does not enforce code set validations.
|
false |
|
Use Version Association Code |
Boolean |
Whether to use UNH0205 (Version Association Code):
-
true
The connector uses UNH0205 (Version Association Code).
-
false
The connector does not use UNH0205 (Version Association Code)
|
false |
|
Use segment line ending in the last line |
Boolean |
Whether to use segment line ending characters in the last line of the segment:
-
true
The connector uses the configured Segment line ending value at the end of the last line in the segment.
-
false
The connector does not use the configured Segment line ending value at the end of the last line in the segment.
|
false |
|
Lock Mechanism |
-
AUTO
-
RUNTIME_LOCK_MANAGER
-
OBJECT_STORE
|
Determines the mechanism used to manage locks for control number sequencing. Valid values are:
-
AUTO
The connector chooses between OBJECT_STORE and RUNTIME_LOCK_MANAGER based on the environment in which the Mule app is running.
-
When the app is deployed to CloudHub 1.0, the connector uses the OBJECT_STORE mechanism for lock management.
-
When the app is deployed to standalone Mule runtime, Runtime Fabric, or CloudHub 2.0, the connector uses the runtime’s distributed locking.
You can use this option with:
-
CloudHub 1.0 deployments with multiple workers or replicas
-
CloudHub 2.0 and Runtime Fabric deployments with one worker or replica
-
Hybrid standalone deployments, including clustered Mule runtimes
-
RUNTIME_LOCK_MANAGER
The connector always uses the runtime’s distributed locking mechanism. (Recommended when the environment has only one worker.)
You can use this option with:
-
CloudHub 1.0, CloudHub 2.0, and Runtime Fabric deployments with one worker or replica
-
Hybrid standalone deployments, including clustered Mule runtimes
-
OBJECT_STORE
The connector always uses an alternative mechanism in environments in which the runtime’s distributed locking mechanism doesn’t work. (Recommended when the environment has more than one worker.)
You can use this option with:
-
CloudHub 1.0, CloudHub 2.0, and Runtime Fabric deployments with multiple workers or replicas
-
Hybrid standalone deployments, including clustered Mule runtimes
|
AUTO |
|