Organization Settings | Aayu Technologies
EDI and AS2 Gateways by Aayu Technologies
mft gateway logo as2 gateway logo edi generator logo
Link Search Menu Expand Document
logo
Contact

Organization Settings

In addition to the basic/mandatory configurations mentioned in the 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.

  • 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.

  • partnerAS2ID: global/unique AS2 identifier used by the partner
  • partnerName: friendly name of the partner, as defined on your own EDIG account
  • x12ISAIDQualifier: X12 ISA ID qualifier/prefix assigned to this partner, e.g. “ZZ”
  • x12ISAIdentifier: global X12 ISA ID used by the partner
  • x12GSCode: global X12 GS code used by the partner
  • x12VerISA12: 5-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:

  • partnerDesc: description of the partner, set on your EDIG account
  • ediType: type of EDI documents sent/received by this partner, e.g. “X12”
  • x12AuthISA01: X12 authorization information qualifier (ISA01) used by the partner
  • x12AuthISA02: X12 authorization information (ISA01) used by the partner
  • x12SecISA03: X12 security information qualifier (ISA03) used by the partner
  • x12SecISA04: X12 security information (ISA04) used by the partner
  • x12RepCharISA11: 1-letter X12 interchange control standards identifier (ISA11) used by the partner, e.g. “U”
  • x12AckReqISA14: binary code (0/1) (ISA14) indicating whether the partner requires acknowledgements (e.g. 997 responses) for document exchange
  • x12UsageISA15: 1-letter X12 data usage indicator (ISA15) used by the partner (usu. T/P/I for test/production/information)
  • x12RespAgencyGS7: 1/2 character X12 responsible agency code (GS07) used by the partner, e.g. “X”
  • x12VersionReleaseGS8: 6-digit code (GS08) of the X12 version release used by this partner for document exchange, e.g. “004010”
  • x12ElementSep: X12 element separator character used by the partner, e.g. “*”
  • x12SegmentSep: X12 segment separator character used by the partner, e.g. “~”
  • x12CompElementSep: X12 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).

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

  • addressLine1: Address Line 1 field
  • addressLine2: Address Line 2 field
  • city
  • state
  • postcode
  • country
  • ediDomain: comma-separated list of EDI Domains enabled on your account, e.g. “retail”
  • primaryMobileNumber: Primary Mobile Number field, if SMS notifications are enabled
  • secondaryMobileNumber: Secondary Mobile Number field, if SMS notifications are enabled
  • email: Email 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

  • from: name of the sending party (partner in this case), assigned on EDIG
  • partnerID: AS2 ID of the sending party
  • funcGroupCtrlNo: group control number (GS06) from the document’s functional-group header
  • displayKey: a string generated by EDIG, representing the document, e.g. for an incoming PO, a comma-separated list of included PO numbers
  • date: received time
  • displayType: 2-letter functional identifier code, e.g. “PO” for a PO
  • txnType: document/transaction type numeric code (ST01), e.g. “850” for a PO
  • txnNo: transaction 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:

  • error: descriptive error phrase, if the document has faced a processing error
  • faMsgId: internal ID of the functional acknowledgement document sent out for this document (if already sent)
  • integrationType: type of the external integration to which the document would be/has been dispatched, e.g. “http”
  • ISA: array (comma-separated list) of the document’s ISA header content
  • GS: array (comma-separated list) of the document’s GSA header content
  • isFA: true/false; is this document itself, an acknowledgement for a previous exchange? (e.g. X12 997 FA)
  • testSubmit: true/false; is this a “dummy” or “test” document, submitted through the EDI test console?