---
schema_version: "1"
id: 5939c111585fd3b1b82b6deb6b5c5551a5fe4a8d7320b4fa6f52c9d1af716f04
title: EDIFACT EDI Connector 3.0 Configuring Schemas
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/edifact-edi-connector/latest/edifact-edi-connector-config-topics.md
canonical_url: https://docs.mulesoft.com/edifact-edi-connector/latest/edifact-edi-connector-config-topics
source_site: docs.mulesoft.com
content_type: documentation
content_hash: b954a722096221d2c5a687b8ce8043832f534291898abab8bbc213e1931ceba8
description: MuleSoft Documentation Site
release: "3.0"
latest: true
---
---
product: EDIFACT EDI Connector
version: 3.0
is-latest-version: true
---

# EDIFACT EDI Connector 3.0 Configuring Schemas

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Standard versions of the schemas for all defined EDIFACT messages and supported versions are
included with this connector. If your implementation conventions differ from the standard, you can
create schemas to describe your messages.

## Set Your Schema Locations

To configure schemas in Anypoint Studio:

1.  Switch to the XML view by clicking **Configuration XML**.

2.  To include a list of all schemas, add an `<http://edischema[edi:schema]>` element for each
    document type to your EDIFACT EDI configuration:

```xml
<edifact:config name="EDIFACT_EDI__Configuration" doc:name="EDIFACT EDI: Configuration">
  <edifact:schemas>
    <edifact:schema value="/edifact/d96a/ORDERS.esl"/>
  </edifact:schemas>
</edifact:config>
```

After you create a global element for your EDIFACT EDI in Studio, configure any schemas and
operations.

### Configuration Options in XML

All values listed in the Studio configuration can be set directly in XML.

General parameters control both Send and Receive document handling.

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>schemas=list of values</p></td><td><p>List of schema paths the connector can use. Each path can be either a file system or <code>classpath</code>.</p></td></tr><tr><td><p>stringSubstitutionChar</p></td><td><p>Substitution character used to replace invalid characters within string values when using the syntax level UNOA or UNOB.</p></td></tr><tr><td><p>separatorUsage="USE_DEFAULTS"/"USE_SPECIFIED_FOR_WRITES"/"USE_SPECIFIED_FOR_ALL"</p></td><td><p>Specification to use either separator or release characters as defaults for messages.</p></td></tr><tr><td><p>dataSeparator="+"</p></td><td><p>Data element separator character.</p></td></tr><tr><td><p>componentSeparator=":"</p></td><td><p>Component element separator character.</p></td></tr><tr><td><p>repetitionSeparator="*"</p></td><td><p>Repetition separator character.</p></td></tr><tr><td><p>segmentTerminator="'"</p></td><td><p>Segment terminator character.</p></td></tr><tr><td><p>releaseCharacter="?"</p></td><td><p>Release character.</p></td></tr><tr><td><p>lockMechanism="AUTO"/"RUNTIME_LOCK_MANAGER"/"OBJECT_STORE"</p></td><td><p>Mechanism to use to manage locks for control number sequencing.</p></td></tr></tbody></table>

## Self-Identification Parameters

Use these parameters to identify your side of the trading partner relationship:

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>interchangeIdSelf</p></td><td><p>Mule interchange Sender or Receiver ID (UNB2.1/UNB3.1).</p></td></tr><tr><td><p>interchangeIdQualifierSelf</p></td><td><p>Interchange Sender or Receiver ID qualifier (UNB2.2/UNB3.2).</p></td></tr></tbody></table>

## Partner Identification Parameters

These identify your partner.

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>interchangeIdPartner</p></td><td><p>Partner interchange Sender or Receiver ID for Mule application (UNB2.1/UNB3.1).</p></td></tr><tr><td><p>interchangeIdQualifierPartner</p></td><td><p>Partner interchange Sender or Receiver ID qualifier (UNB2.2/UNB3.2).</p></td></tr></tbody></table>

## Parser Parameters for Error Conditions

These control the parser operation and the types of error conditions that reject Receive messages.

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value (default)</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>enforceLengthLimits="true"</p></td><td><p>Enforce the minimum and maximum lengths for receive values.</p></td></tr><tr><td><p>truncateExceedingMaxLength="false"</p></td><td><p>Truncate to the maximum lengths for received values.</p></td></tr><tr><td><p>enforceValueRepeats="true"</p></td><td><p>Enforce the repetition count limits for receive values.</p></td></tr><tr><td><p>enforceReadCharacters="true"</p></td><td><p>Enforce valid characters for a Read operation. Only applies when using syntax levels <code>UNOA</code> and <code>UNOB</code>.</p></td></tr><tr><td><p>allowUnknownSegments="false"</p></td><td><p>Allow unknown segments in a message.</p></td></tr><tr><td><p>enforceSegmentOrder="true"</p></td><td><p>Enforce the segment order in a message.</p></td></tr><tr><td><p>allowUnusedSegments="false"</p></td><td><p>Allow segments marked as <code>Unused</code> in a message.</p></td></tr><tr><td><p>enforceSegmentRepeats="true"</p></td><td><p>Enforce segment repetition count limits in a message.</p></td></tr><tr><td><p>receiveEncodingOverride="false"</p></td><td><p>Java character encoding used for Receive messages. This overrides receive UNB.</p></td></tr><tr><td><p>requireUniqueInterchanges="true"</p></td><td><p>Require unique interchange control references (such as UNB.5). The default behavior records the interchange numbers previously processed and rejects duplicate interchange numbers from the same partner. It is derived from the interchange Sender and Receiver identification. Setting to <code>false</code> enables received interchange processing to continue and relies on the application flow to track the numbers and manage them appropriately.</p></td></tr><tr><td><p>requireUniqueGroups="false"</p></td><td><p>Enforce globally unique group control numbers (UNG.5) for received functional groups. By default, group control numbers must be unique only within an interchange. Setting this value to <code>true</code> requires group numbers to be unique across all interchanges received from the same partner and application, as determined by the interchange sender and recipient identification.</p></td></tr><tr><td><p>requireUniqueMessages="false"</p></td><td><p>Enforce globally unique message reference numbers (UNH.1) for received messages. By default, message reference numbers must be unique only within a particular interchange. Setting this value to <code>true</code> requires message reference numbers to be unique across all interchanges received from the same partner and application, as determined by the interchange sender and recipient identification.</p></td></tr><tr><td><p>daysToStore="30"</p></td><td><p>Minimum number of days to store interchange, group, and message numbers for uniqueness checking.</p></td></tr><tr><td><p>enforceCodeSetValidationsParse="false"</p></td><td><p>Enforce code set validations on the <strong>Read</strong> operation.</p></td></tr><tr><td><p>parseUseVersionAssociationCode="false"</p></td><td><p>Enforce Edifact version using UNH0205 (association code) on the <strong>Read</strong> operation.</p></td></tr></tbody></table>

## Writer Parameters

These control the types of writer operations.

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value (default)</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>characterEncoding="ASCII_B"</p></td><td><p>Character encoding used for writing messages. There must be one defined in each EDIFACT syntax version.</p></td></tr><tr><td><p>sendSyntaxVersion="VERSION4"</p></td><td><p>Syntax version for Send messages. Used to determine the data structures for service segments and CONTRL acknowledgment message structures in DataSense metadata for both Send and Receive.</p></td></tr><tr><td><p>lineEnding="NONE" "LF" "CRLF" "CR"</p></td><td><p>Line ending to add between segments. Improves the readability of the output message text by adding line endings between segments.</p></td></tr><tr><td><p>writeUseCRLFLastLine="false"</p></td><td><p>Use the configured <strong>Segment Line Ending</strong> value at the end of the last line.</p></td></tr><tr><td><p>alwaysSendUNA="false"</p></td><td><p>Always send the UNA service segment. A UNA is included only in an interchange when the syntax separator characters don’t match the defaults for both the syntax version and character encoding when in use. Setting to <code>true</code> means a UNA is always sent.</p></td></tr><tr><td><p>enforceWriteCharacters="true"</p></td><td><p>Enforce valid characters for a Write operation. This applies when using syntax levels <code>UNOA</code> and <code>UNOB</code>.</p></td></tr><tr><td><p>useWriteFunctionalGroups="false"</p></td><td><p>If <code>true</code>, the connector classifies each message by the corresponding functional group (UNG-UNE), according to its type. By default, the connector doesn’t classify messages by functional group.</p></td></tr><tr><td><p>sendUniqueGroupNumbers="false"</p></td><td><p>Send unique group reference numbers (UNG.1). By default, message reference numbers are assigned sequentially within each interchange and are reused in a different interchange. If <code>true</code>, the connector assigns unique message numbers across all interchanges sent to the same partner, as determined by the interchange sender and recipient identification.</p></td></tr><tr><td><p>sendUniqueMessageNumbers="false"</p></td><td><p>Send unique Message Reference Numbers (UNH.1). <code>false</code> (default) assigns message reference numbers sequentially within each interchange and reuses them in a different interchange. <code>true</code> assigns unique transaction set numbers across all interchanges sent to the same partner. It is derived by the interchange sender and recipient identification.</p></td></tr><tr><td><p>initialInterchangeReference="1"</p></td><td><p>The initial interchange control reference used for outgoing messages.</p></td></tr><tr><td><p>initialGroupReference="1"</p></td><td><p>The initial group reference number used for outgoing messages.</p></td></tr><tr><td><p>initialMessageReference="1"</p></td><td><p>The initial Message Reference Number used for outgoing messages.</p></td></tr><tr><td><p>requestAcks="false"</p></td><td><p>Request acknowledgments for Send interchanges using the Acknowledgment Request field (UNB.9).</p></td></tr><tr><td><p>testIndicator=""</p></td><td><p>Test indicator digit used on Send interchanges (UNB.11). By default interchanges are not sent as tests.</p></td></tr><tr><td><p>useSuppliedValues="false"</p></td><td><p>Choose your own data values for control-segment identifiers such as <code>UNB</code> and <code>UNZ</code> segments or use the supplied values. <code>false</code> always generates control numbers when writing letting you choose values.</p></td></tr><tr><td><p>outputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIFACT"</p></td><td><p>Output MIME type of the message.</p></td></tr><tr><td><p>writeInterchangeControlNumberKey=""</p></td><td><p>Interchange number key for the object store. If a key is specified, it is used for subsequent operations that use the object store for interchange control numbers.</p></td></tr><tr><td><p>writeGroupControlNumberKey=""</p></td><td><p>Group control number key for the object store. If a key is specified, it is used for subsequent operations that use the object store for group control numbers.</p></td></tr><tr><td><p>writeMessageControlNumberKey=""</p></td><td><p>Message control number key for the object store. If a key is specified, it is used for subsequent operations that use the object store for message control numbers.</p></td></tr><tr><td><p>writeEnforceLengthLimits="true"</p></td><td><p>Enforce minimum and maximum lengths for write values. The default of <code>true</code> throws an exception when an element is too long or too short. <code>false</code> leaves the values as-is.</p></td></tr><tr><td><p>writeTruncateExceedingMaxLength="false"</p></td><td><p>Truncate to the maximum lengths for received values.</p></td></tr><tr><td><p>enforceCodeSetValidationsWrite="false"</p></td><td><p>Enforce code set validations on the <strong>Write</strong> operation.</p></td></tr><tr><td><p>writeUseVersionAssociationCode="false"</p></td><td><p>Enforce Edifact version using UNH0205 (association code) on the <strong>Write</strong> operation.</p></td></tr></tbody></table>

## Write-Batch Parameters

These control the types of write-batch operations.

<table><colgroup><col> <col></colgroup><thead><tr><th>XML Value (default)</th><th>Studio Option</th></tr></thead><tbody><tr><td><p>batchCharacterEncoding="ASCII_B"</p></td><td><p>Character encoding used for writing messages. There must be one defined in each EDIFACT syntax version.</p></td></tr><tr><td><p>batchSendSyntaxVersion="VERSION4"</p></td><td><p>Syntax version for Send messages. Used to determine the data structures for service segments and CONTRL acknowledgment message structures in DataSense metadata for both Send and Receive.</p></td></tr><tr><td><p>batchLineEnding="NONE"/"LF"/"CRLF"/"CR"</p></td><td><p>Line ending to add between segments. Improves the readability of the output message text by adding line endings between segments.</p></td></tr><tr><td><p>batchUseCRLFLastLine="false"</p></td><td><p>Use the configured <strong>Segment Line Ending</strong> value at the end of the last line.</p></td></tr><tr><td><p>batchAlwaysSendUNA="false"</p></td><td><p>Always send the UNA service segment. A UNA is included only in an interchange when the syntax separator characters don’t match the defaults for both the syntax version and character encoding when in use. Setting to <code>true</code> means a UNA is always sent.</p></td></tr><tr><td><p>batchEnforceWriteCharacters="true"</p></td><td><p>Enforce valid characters for a Write operation. This applies when using syntax levels <code>UNOA</code> and <code>UNOB</code>.</p></td></tr><tr><td><p>batchSendUniqueMessageNumbers="false"</p></td><td><p>Send unique Message Reference Numbers (UNH.1). <code>false</code> (default) assigns Message Reference Numbers sequentially within each interchange and reuses them in a different interchange. <code>true</code> assigns unique transaction set numbers across all interchanges sent to the same partner. It is derived by the interchange sender and recipient identification.</p></td></tr><tr><td><p>useBatchFunctionalGroups="false"</p></td><td><p>If <code>true</code>, the connector classifies each message by the corresponding functional group (UNG-UNE). By default, messages are not classified by functional group.</p></td></tr><tr><td><p>batchSendUniqueGroupNumbers="false"</p></td><td><p>Send unique group reference numbers (UNG.1). By default, the connector assigns message reference numbers sequentially within each interchange and reuses them in different interchanges. If <code>true</code>, the connector assigns unique message reference numbers across all interchanges sent to the same partner, as determined by the interchange sender and recipient identification.</p></td></tr><tr><td><p>batchInitialInterchangeReference="1"</p></td><td><p>The initial interchange control reference used for outgoing messages.</p></td></tr><tr><td><p>batchInitialGroupReference="1"</p></td><td><p>The initial group reference number used for outgoing messages.</p></td></tr><tr><td><p>batchInitialMessageReference="1"</p></td><td><p>The initial Message Reference Number used for outgoing messages.</p></td></tr><tr><td><p>batchRequestAcks="false"</p></td><td><p>Request acknowledgments for Send interchanges using the Acknowledgment Request field (UNB.9).</p></td></tr><tr><td><p>batchTestIndicator=""</p></td><td><p>Test indicator digit used on Send interchanges (UNB.11). By default interchanges are not sent as tests.</p></td></tr><tr><td><p>batchUseSuppliedValues="false"</p></td><td><p>Choose your own data values for control-segment identifiers such as <code>UNB</code> and <code>UNZ</code> segments or use the supplied values. <code>false</code> always generates control numbers when writing, letting you choose values.</p></td></tr><tr><td><p>batchOutputEdiMimeType="APPLICATION_PLAIN"/"APPLICATION_EDIFACT"</p></td><td><p>Output MIME type of the message.</p></td></tr><tr><td><p>batchInterchangeControlNumberKey=""</p></td><td><p>Interchange number key for object store. If a key is specified, then that key is used for subsequent operations involving the object store for interchange control numbers.</p></td></tr><tr><td><p>batchGroupNumberKey=""</p></td><td><p>Group control number key for the object store. If a key is specified, it is used for subsequent operations that use the object store for the group control numbers.</p></td></tr><tr><td><p>batchMessageControlNumberKey=""</p></td><td><p>Message control number key for an object store. If a key is specified, it is used for subsequent operations that use the object store for the message control number.</p></td></tr><tr><td><p>batchEnforceLengthLimits="true"</p></td><td><p>Enforce minimum and maximum lengths for write values. If true, a element with values too long or too short throws an exception; if false, the values are used anyway.</p></td></tr><tr><td><p>batchTruncateExceedingMaxLength="false"</p></td><td><p>Truncate to the maximum lengths for received values.</p></td></tr><tr><td><p>enforceCodeSetValidationsBatch="false"</p></td><td><p>Enforce code set validations on the <strong>Write Batch</strong> operation.</p></td></tr><tr><td><p>batchUseVersionAssociationCode="false"</p></td><td><p>Enforce Edifact version using UNH0205 (association code) on the <strong>Write Batch</strong> operation.</p></td></tr></tbody></table>

## Next Step

After you complete configuring the connector, you can try the
[Examples](https://docs.mulesoft.com/edifact-edi-connector/latest/edifact-edi-connector-examples).

## See Also

- [Salesforce Help](https://help.salesforce.com)