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
| Rule | Detail |
|---|---|
| Syntax | KEY=value — an = is required |
| Flags | 0 or 1 only |
| Integers | Whole numbers; some keys have min/max (see table) |
| Strings | Non-empty value |
| Protocol scope | Some keys apply only to specific protocols (noted in table) |
Supported keys
| Key | Type | Range / values | Protocol scope | Purpose |
|---|---|---|---|---|
SEND_DELAY | int | 0–43200 | All | Delay send by N minutes after trigger |
SEND_PICTURES_CHUNK_SIZE | int | 0–10000 | All | Split picture uploads into chunks of at most N pictures |
PIC_RESIZE_X | int | 0–20000 | All | Resize width (pixels) before send; 0 = no resize |
PIC_RESIZE_Y | int | 0–20000 | All | Resize height (pixels) before send; 0 = no resize |
PIC_COMPRESSION | int | 0–95 | All | JPEG quality after resize |
DRY_RUN | flag | 0 / 1 | All | 1 = simulate send without delivering |
TEST_MODE | flag | 0 / 1 | All | 1 = test-mode behaviour (per handler) |
WEB_ONLY | flag | 0 / 1 | All | 1 = destination hidden from mobile /tags actions |
INPUT_ESTIMATE_ID | flag | 0 / 1 | All | 1 = Gallery send requires estimate ID; excluded from mobile actions |
INPUT_ESTIMATE_DATE | flag | 0 / 1 | All | 1 = Gallery send requires estimate date; excluded from mobile actions |
INPUT_MESSAGE_BODY | flag | 0 / 1 | MAIL only | 1 = Gallery send requires message body; excluded from mobile actions |
ESTIMATE_DATE_FORMAT | string | e.g. Ymd, yyyy-mm-dd | All | Format for {estimate_date} placeholder in subject/filename/body |
SFTP_HOSTKEY_STRICT | flag | 0 / 1 | SFTP family | 1 = enforce host-key verification |
SFTP_HOSTKEY | string | non-empty | SFTP family | Expected host key (format per handler) |
SFTP_HOSTKEY_SHA256 | string | non-empty | SFTP family | SHA-256 host-key fingerprint |
SFTP_HOSTKEY_MD5 | string | non-empty | SFTP family | MD5 host-key fingerprint |
LOCALOVERLAY | flag | 0 / 1 | LOCAL | Local delivery overlay option |
LOCAL_JSON | flag | 0 / 1 | LOCAL | Emit JSON sidecar for local delivery |
PICTURE_DATE_DAYS | int | 1–365 | EOS | Picture date window for EOS API |
MAERSK_MODE | string | non-empty | API (AEMS) | Maersk AEMS mode string |
ORDER_STATUS | int | 100–599 | API (AEMS) | Filter maintenance orders by status code |
MAIL_INCLUDE_BODY | flag | 0 / 1 | Legacy — prefer dedicated email body fields in the editor | |
MAIL_BODY_TEXT | string | non-empty | Legacy default body text | |
SMTP_CONFIG_PICTURES | string | config key | Pin 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
| Placeholder | Meaning |
|---|---|
{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)
| Legacy | Use 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 onlyINPUT_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.
Related
- EDI destinations — protocols, walkthrough, document types
- SMTP — platform defaults, tenant configs, outbound route
- Send — Destinations — end-user send flow