Skip to content
Manage access · Change password · Log out

EDI (Electronic Data Interchange)

EDI lets the depot automatically send structured messages (typically CODECO gate-event messages) to shipping-line trading partners whenever a container is gated in or out. Three screens work together: EDI Templates define the message content, EDI Partners map a shipping line's gate events to a template and a delivery transport, and EDI Messages is the outbound delivery log.

Before you start

  • Company → EDI Sender ID must be set. This identifies the depot to trading partners in the outbound message's sender header. If left blank, the company name is used instead — partners will usually reject that.
  • A Shipping Line must exist before you can create a partner config for it.

Walkthrough

EDI Templates (Settings → Communications → EDI Templates)

Click New Template to open the editor:

  • Name (required)
  • Message Type — CODECO — Gate In, CODECO — Gate Out, or Custom
  • Format — EDIFACT, X12, CSV, or JSON
  • Active checkbox
  • EDI Body — the message content, edited directly using placeholders for dynamic values. A Variables panel on the right lists the predefined placeholders available for the selected message type (click to insert at the cursor), plus any Meta Fields defined for Gate Pass — since EDI messages are triggered by gate events, custom fields come specifically from the Gate Pass entity.

Once a template is saved, use Preview to see a fully rendered message body before relying on it in production. Templates can be deleted from the editor (with confirmation) if unused.

EDI Partners (Settings → Communications → EDI Partners)

Click Add Config to map a shipping line's gate event to a template and transport:

  • Shipping Line (required)
  • Event — Gate In or Gate Out
  • Transport — HTTP, Email, or SFTP
  • EDI Template (required) — select from templates created above

Transport-specific fields appear based on the choice:

  • HTTP — Endpoint URL (required), optional HMAC Secret
  • Email — Recipients (required, comma-separated), optional Subject
  • SFTP — Host (required), Port, Username (required), Password, Remote Dir (required), optional Filename

The list view can be filtered by shipping line and shows each config's event, template, transport, and active status. Configs can be deleted from the list.

EDI Messages (Settings → Communications → EDI Messages)

A read-only delivery log — every message actually sent (or attempted) as a result of a gate event hitting a configured partner. Filter by status (Pending, Sent, Failed). Click a row to view its rendered payload and, if it failed, the error message. A Resend button on each row retries delivery.

Who can access this

Admin and Manager — Settings is gated to these two roles (see Logging in & roles).