Skip to main content

EDI Params reference

The Params field on each EDI destination is an INI-style text block: one KEY=value per line. Lines starting with # or ; are comments. Keys are case-insensitive in the editor but stored uppercase.

The Tenant Admin editor validates keys against the list below. Unknown keys show an error with a fuzzy “did you mean?” hint.

For how to create destinations and when to use Params, see EDI destinations.

INI format

# Example: resize before FTP upload, dry-run for testing
PIC_RESIZE_X=1280
PIC_RESIZE_Y=960
PIC_COMPRESSION=85
DRY_RUN=1
RuleDetail
SyntaxKEY=value — an = is required
Flags0 or 1 only
IntegersWhole numbers; some keys have min/max (see table)
StringsNon-empty value
Protocol scopeSome keys apply only to specific protocols (noted in table)

Supported keys

KeyTypeRange / valuesProtocol scopePurpose
SEND_DELAYint0–43200AllDelay send by N minutes after trigger
SEND_PICTURES_CHUNK_SIZEint0–10000AllSplit picture uploads into chunks of at most N pictures
PIC_RESIZE_Xint0–20000AllResize width (pixels) before send; 0 = no resize
PIC_RESIZE_Yint0–20000AllResize height (pixels) before send; 0 = no resize
PIC_COMPRESSIONint0–95AllJPEG quality after resize
DRY_RUNflag0 / 1All1 = simulate send without delivering
TEST_MODEflag0 / 1All1 = test-mode behaviour (per handler)
WEB_ONLYflag0 / 1All1 = destination hidden from mobile /tags actions
INPUT_ESTIMATE_IDflag0 / 1All1 = Gallery send requires estimate ID; excluded from mobile actions
INPUT_ESTIMATE_DATEflag0 / 1All1 = Gallery send requires estimate date; excluded from mobile actions
INPUT_MESSAGE_BODYflag0 / 1MAIL only1 = Gallery send requires message body; excluded from mobile actions
ESTIMATE_DATE_FORMATstringe.g. Ymd, yyyy-mm-ddAllFormat for {estimate_date} placeholder in subject/filename/body
SFTP_HOSTKEY_STRICTflag0 / 1SFTP family1 = enforce host-key verification
SFTP_HOSTKEYstringnon-emptySFTP familyExpected host key (format per handler)
SFTP_HOSTKEY_SHA256stringnon-emptySFTP familySHA-256 host-key fingerprint
SFTP_HOSTKEY_MD5stringnon-emptySFTP familyMD5 host-key fingerprint
LOCALOVERLAYflag0 / 1LOCALLocal delivery overlay option
LOCAL_JSONflag0 / 1LOCALEmit JSON sidecar for local delivery
PICTURE_DATE_DAYSint1–365EOSPicture date window for EOS API
MAERSK_MODEstringnon-emptyAPI (AEMS)Maersk AEMS mode string
ORDER_STATUSint100–599API (AEMS)Filter maintenance orders by status code
MAIL_INCLUDE_BODYflag0 / 1MAILLegacy — prefer dedicated email body fields in the editor
MAIL_BODY_TEXTstringnon-emptyMAILLegacy default body text
SMTP_CONFIG_PICTURESstringconfig keyMAILPin outbound mail to a single named tenant SMTP config (see SMTP)

SMTP_CONFIG_PICTURES (MAIL destinations)

When set to a tenant SMTP config key (for example MAIL or OPERATIONS):

  • Only that named SMTP row is used for this MAIL destination
  • The tenant primary → fallback → platform chain is not used
  • If the key cannot be resolved, the send fails with no_smtp_config (no fallback)

When omitted, MAIL destinations use the normal outbound SMTP chain (tenant route, then platform defaults).

Filename, subject, and body placeholders

Use {name} tokens in Email subject, Filename mask, and Email body (MAIL). The backend substitutes these at send time.

Supported placeholders

PlaceholderMeaning
{terminal}Terminal code
{container}Container code
{case_date}Case date
{dtingresso}Ingress date (alias)
{date}Date context
{today}Current date
{current_date}Current date
{today:…} / {current_date:…}Date with custom format suffix
{counter}{counter5}Send counters
{user_first_name} {user_last_name} {user_email} {user_username}Sending user
{sender} {receiver} {location} {dest_name} {protocol} {device_id}Destination metadata
{estimate_id} {estimate_date}User-supplied estimate inputs
{remark} {tags} {notes} {licence_plate}Case / picture metadata

Legacy aliases (avoid in new configs)

LegacyUse instead
{est_num}{estimate_id}
{est_date}{estimate_date}

When ESTIMATE_DATE_FORMAT is set in Params, {estimate_date} is rendered using that format (the editor shows a preview hint).

Mobile app interaction

Destinations with any of these Params set to 1 are not offered as mobile upload actions (WEB_ONLY, INPUT_ESTIMATE_ID, INPUT_ESTIMATE_DATE, INPUT_MESSAGE_BODY):

  • WEB_ONLY=1 — web Gallery only
  • INPUT_ESTIMATE_* / INPUT_MESSAGE_BODY — mobile cannot collect the required fields

See Tags and the mobile API contract (POST /api/v1/mobile/tags in docs/api/mobile-client-contract.md) for how /tags builds the actions[] list.