Advanced Settings
In addition to the basic/mandatory configurations mentioned in the basic account set-up guide, you can adjust several other account-level settings to fine-tune the way that EDI Generator will handle your EDI transactions.
Processing
This section mainly controls how EDIG will process incoming documents on your account, send back responses, etc.
Preserve CR/LF characters (newlines) in incoming files
By default, the EDI Generator will remove the CR/LF characters (newlines) from the incoming EDI files before processing them. This setting can be enabled to omit that and step and preserve those characters for the processing. This setting must be enabled, if your partner is using newline as the segment separator.
Outgoing Filename Format
Controls naming format of outgoing files (e.g. invoices generated from the web interface, or EDIs composed from outbox).
If not specified, EDIG will use the default format ${txnType}${displayType}_${timestamp}.edi.txt
Response Filename Format
Controls naming format of files that are sent back as a response to an originally incoming file (e.g. auto-generated X12 997 or EDIFACT CONTRL, for an incoming PO or ORDERS). If not specified, EDIG will use the Outgoing Filename Format itself, or fall back to the latter’s default.
Ignore incoming documents from
If you receive EDIs from some sender, that you wish to ignore/skip processing, but have no other way to prevent them from being pushed to EDIG, you can specify such senders’ ISA identifiers here. EDIG will completely skip ingesting of files that match these ISAs, without processing/forwarding them further or saving them in your inbox.
File naming
Files sent out by EDIG are named using a common naming standard, configurable under Processing section of your organization configuration. You can use following placeholder expressions to insert contextual details to the filename, such as timestamps and sender/recipient identification values. Some variables are resolved automatically according to the partner’s EDI standard, X12 or EDIFACT, so the same format works for both. Empty variables are skipped and the remaining variables are used for the file name. If all are empty, the default file name format ${txnType}${displayType}_${timestamp}.edi.txt is used.
To prevent duplicate file names, EDI Generator checks if the configured format contains unique fields such as ${timestamp} or ${txnNo}. If no unique fields are present (or if they resolve to empty values), EDI Generator will automatically append a timestamp before the file extension.
${txnNo} | transaction/message number (ST02/ UNH01) from the outgoing file (or comma-separated list if document has multiple transactions) |
${displayType} | 2-letter functional identifier code (GS01, e.g. “SH” for ASN) from the outgoing file, for X12 documents or the EDIFACT message type (UNH02-01 e.g. “INVOIC” for invoice, “DESADV” for dispatch advice) from the outgoing file |
${documentType} | X12 numeric transaction type (ST01, e.g. 856 for ASN) or EDIFACT message type (UNH02-01 e.g. “INVOIC” for invoice, “DESADV” for dispatch advice/ASN) from the outgoing file |
${timestamp} | file received timestamp, in “sanitized” ISO yyyy-MM-dd'T'HH-mm-ss.SSS'Z' format; i.e. the standard formatted value, with : characters (which could cause problems on Windows systems) replaced by - |
${partner.<fieldName>} | a desired field of the partner entry representing the EDI’s recipient; see this section for supported fields |
${tenant.<fieldName>} | a desired field of your (sender’s) tenant/organization details; see this section for supported fields |
Partner references (partner.<fieldName>): supported fields
These come from the associated partner, e.g. the final intended recipient of a document generated by EDIG. Use these fields if you wish to adjust the filename based on each recipient, or if your partner expects any of their identification information (such as their AS2/SFTP ID, or X12/EDIFACT identifiers) on the files that you send to them.
partnerID | AS2/SFTP identifier used by the partner |
partnerName | friendly name of the partner, as defined on your own EDIG account |
interchangeIDQualifier | interchange ID qualifier/prefix assigned to this partner (X12 ISA ID qualifier, or EDIFACT UNB interchange sender/recipient qualifier), e.g. “ZZ” |
interchangeID | global interchange ID used by the partner (X12 ISA ID, or EDIFACT UNB interchange sender/recipient identifier) |
applicationID | global application-level ID used by the partner (X12 GS code, or EDIFACT UNG application sender/recipient code) |
Following fields are also available, however they would generally not be suitable/meaningful for use in filenames.
ediType | type of EDI documents sent/received by this partner, e.g. “X12” |
versionRelease | code identifying the envelope syntax version standard used by this partner for document exchange (X12 ISA12 version, or EDIFACT UNB syntax version), e.g. “00401” or “3” |
edifactSyntaxID | EDIFACT syntax identifier (UNB) used by the partner, e.g. “UNOA” or “UNOB” |
Tenant references (tenant.<fieldName>) supported fields
These come from your tenant/organization settings. Use these fields if you wish to include your own identification information (such as your AS2 ID, or ISA/GS identifiers) on the files that you send to your partners (or if your partner has requested you to do so).
name | your EDIG account name (usually in a domain-name format) |
as2ID | Your AS2 identifier used to send the message |
interchangeIDQualifier | For X12 ISA ID qualifier/prefix, e.g. “ZZ”; for EDIFACT, UNB qualifier/prefix, e.g. “ZZ” that was used in the transaction |
interchangeID | For X12 ISA ID; for EDIFACT, UNB identifier that was used in the transaction |
applicationID | For X12 GS code; for EDIFACT, UNG code that was used in the transaction |
Response file naming
Sometimes an EDI file may be sent as a direct response to an incoming document, i.e. it is directly associated with an “original” document. This setting allows you to further customize the names of such “response” files, by including metadata/fields from the original document.
In addition to fields described above under File naming, you can use an ${original.<fieldName>} syntax to include desired properties of the original document into the final filename.
Document references (original.<fieldName>): supported fields
from | name of the sending party (partner in this case), assigned on EDIG |
partnerID | AS2/SFTP ID of the sending party |
funcGroupCtrlNo | group control number (X12 GS06 or EDIFACT UNG05) from the document’s functional-group header |
displayType | For X12 2-letter functional identifier code, e.g. “PO” for a PO, for EDIFACT message type (UNH02-01 e.g. “INVOIC” for invoice, “DESADV” for dispatch advice/ASN) |
txnType | For X12 document/transaction type numeric code (ST01), e.g. “850” for a PO, for EDIFACT message type (UNH02-01 e.g. “INVOIC” for invoice, “DESADV” for dispatch advice/ASN) |
txnNo | transaction number (ST02/UNH01) (or comma-separated list in case of multiple transactions) |
messageID | unique ID of the original message |