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 initial ACK, for an incoming PO). 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.

Process incoming EDIFACT files

Turn this on to enable accepting and processing of EDIFACT files, in addition to X12. Currently, EDIG offers limited support for handling EDIFACT files, including JSON conversion based on partner/document type definitions, and forwarding to external integrations. When EDIFACT support becomes mainstream, the setting may be removed from this section.


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.

${txnNo}transaction number (ST02) from the outgoing file (or comma-separated list if document has multiple transactions)
${txnType}numeric transaction type (ST01, e.g. 856 for ASN) from the outgoing file
${displayType}2-letter functional identifier code (GS01, e.g. “SH” for 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 own AS2 ID, or ISA/GS identifiers) on the files that you send to them.

partnerAS2IDglobal/unique AS2 identifier used by the partner
partnerNamefriendly name of the partner, as defined on your own EDIG account
x12ISAIDQualifierX12 ISA ID qualifier/prefix assigned to this partner, e.g. “ZZ”
x12ISAIdentifierglobal X12 ISA ID used by the partner
x12GSCodeglobal X12 GS code used by the partner
x12VerISA125-digit code (ISA12) of the X12 version standard used by this partner for document exchange, e.g. “00401”

Following fields are also available, however they would generally not be suitable/meaningful for use in filenames; you may be able to use some of them, such as the description, to pass more contextual (per-partner) information to the filename generation step:

partnerDescdescription of the partner, set on your EDIG account
ediTypetype of EDI documents sent/received by this partner, e.g. “X12”
x12AuthISA01X12 authorization information qualifier (ISA01) used by the partner
x12AuthISA02X12 authorization information (ISA01) used by the partner
x12SecISA03X12 security information qualifier (ISA03) used by the partner
x12SecISA04X12 security information (ISA04) used by the partner
x12RepCharISA111-letter X12 interchange control standards identifier (ISA11) used by the partner, e.g. “U”
x12AckReqISA14binary code (0/1) (ISA14) indicating whether the partner requires acknowledgements (e.g. 997 responses) for document exchange
x12UsageISA151-letter X12 data usage indicator (ISA15) used by the partner (usu. T/P/I for test/production/information)
x12RespAgencyGS71/2 character X12 responsible agency code (GS07) used by the partner, e.g. “X”
x12VersionReleaseGS86-digit code (GS08) of the X12 version release used by this partner for document exchange, e.g. “004010”
x12ElementSepX12 element separator character used by the partner, e.g. “*”
x12SegmentSepX12 segment separator character used by the partner, e.g. “~”
x12CompElementSepX12 compound element separator character (ISA16) used by the partner, e.g. “>”
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).

nameyour EDIG account name (usually in a domain-name format)
gs1Prefixyour GS1 prefix
as2IDyour global/unique AS2 identifier
x12ISAIDQualifieryour X12 ISA ID qualifier/prefix, e.g. “ZZ”
x12ISAIdentifieryour global X12 ISA ID
x12GSCodeyour global X12 GS code
MFTGTenantname of the MFTG or AS2G tenant/account associated with your EDIG account

Following fields from your account configuration are also available, however they would generally not be suitable/meaningful for use in filenames:

addressLine1Address Line 1 field
addressLine2Address Line 2 field
city 
state 
postcode 
country 
ediDomaincomma-separated list of EDI Domains enabled on your account, e.g. “retail”
primaryMobileNumberPrimary Mobile Number field, if SMS notifications are enabled
secondaryMobileNumberSecondary Mobile Number field, if SMS notifications are enabled
emailEmail field, if email notifications are enabled

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
fromname of the sending party (partner in this case), assigned on EDIG
partnerIDAS2 ID of the sending party
funcGroupCtrlNogroup control number (GS06) from the document’s functional-group header
displayKeya string generated by EDIG, representing the document, e.g. for an incoming PO, a comma-separated list of included PO numbers
datereceived time
displayType2-letter functional identifier code, e.g. “PO” for a PO
txnTypedocument/transaction type numeric code (ST01), e.g. “850” for a PO
txnNotransaction number (ST02) (or comma-separated list in case of multiple transactions)

Following fields are also available, however they would generally not be suitable/meaningful for use in filenames:

errordescriptive error phrase, if the document has faced a processing error
faMsgIdinternal ID of the functional acknowledgement document sent out for this document (if already sent)
integrationTypetype of the external integration to which the document would be/has been dispatched, e.g. “http”
ISAarray (comma-separated list) of the document’s ISA header content
GSarray (comma-separated list) of the document’s GSA header content
isFAtrue/false; is this document itself, an acknowledgement for a previous exchange? (e.g. X12 997 FA)
testSubmittrue/false; is this a “dummy” or “test” document, submitted through the EDI test console?