Skip to main content

EDI

Configure EDI delivery destinations used when sending inspection pictures to depot systems, shipping lines, email recipients, or custom endpoints.

Access

EDI configuration requires the Admin role (or SysAdmin). Other tenant administrators may see the Admin menu but not the EDI item. Backend /api/v1/tenant-admin/edi endpoints are Admin-only.

Tenant Admin EDI destination list

What you can do

  • Add destinations with protocol, connection fields, terminal scope, and Params
  • Name destinations (uppercase DEST_NAME) for selection in the Send dialog and mobile actions
  • Scope terminals — one row per terminal, or ALL for every terminal
  • Enable or disable destinations without deleting history
  • Test FTP-family connections from the editor
  • Search and filter the destination list

Create a destination (walkthrough)

  1. Open Admin → EDI
  2. Click Add EDI
  3. Enter a destination name (stored uppercase, e.g. DEPOT_FTP)
  4. Choose terminals — pick specific codes or All
  5. Select a protocol (see table below)
  6. Fill protocol-specific fields (host, credentials, email addresses, etc.)
  7. Optionally set Params (INI block) — see EDI Params reference
  8. Ensure Active is checked, then Save

Add MAIL EDI destination

Document types (MAIL only)

ValueMeaning
Attached pictures (PICTURES)Email includes picture files as attachments
Picture link (PICTURE_LINK)Email contains links to pictures instead of attachments

Protocols and fields

ProtocolLabelTypical connection fields
LOCALLocal deliveryRemote directory, filename mask
EOSEOS APIFilename mask; Params (PICTURE_DATE_DAYS, etc.)
MAILE-mailTo, CC, subject, filename mask, optional body; document type
FTPFTPHost (host or host:port), remote dir, username, password, filename mask
FTP2FTP streamSame as FTP
FTPSFTPS — explicitSame as FTP
FTPS2FTPS — implicitSame as FTP
SFTPSFTPSame as FTP; host-key Params in Params reference
SFTP2SFTP streamSame as SFTP
APIMaersk AEMS APIAPI address, client ID, client secret, shop code (sender)

Add FTPS EDI destination

Authentication summary

Protocol familyCredentials
FTP / FTPS / SFTPUsername + password (password hidden after save; use Show password to re-enter)
MAILNo SMTP password here — outbound mail uses SMTP chain or SMTP_CONFIG_PICTURES in Params
API (AEMS)OAuth-style client ID and client secret
LOCAL / EOSNo network credentials in the standard editor fields

MAIL-specific options

  • Override sender name — use current admin display name + tenant name
  • Reply-To — fixed address or current user's mailbox
  • Include email body — optional body with {placeholder} support

Pin a specific SMTP config for this destination only:

SMTP_CONFIG_PICTURES=MY_CONFIG_KEY

See SMTP and EDI Params.

How destinations are used

ChannelBehaviour
Gallery SendUsers pick destinations in Send to Destinations; required fields appear when Params request estimate ID/date/body
Auto-sendTerminals, Tags, and Notes can link auto destinations after upload
Mobile app/api/v1/mobile/tags returns actions[] as TERMINAL§DEST_NAME; upload action triggers auto-send
Mail ingestionMail rules and Code mappings reference destination names
Send logOutcomes appear in the Send log

Params and placeholders

Advanced behaviour (resize, chunk size, dry-run, SFTP host keys, AEMS filters) is controlled in the Params textarea. Full key list, types, and placeholder reference:

EDI Params reference →

Tips

  • Use descriptive destination names (LINE_PROD, DEPOT_TEST)
  • Test with DRY_RUN=1 in Params before enabling auto-send on busy terminals
  • Coordinate credential rotation with IT — update passwords before old ones expire
  • For AEMS Gallery behaviour, see AEMS send workflow

See also: SMTP, Code mappings, Send — Destinations