Skip to main content

Create an export template

This is the heart of configuring a template. On the Export templates overview, click New (or From library to start from a ready-made one), fill in the form, and click Save.

The core fields​

  • Name (required) — what you call the template; this is what people pick when they export or send.
  • System code (required) — a short internal code SHIPM8 uses to recognise the template. It's filled from the name; use letters, numbers, and underscores.
  • Object definition (required) — the kind of record the template runs on (an invoice, a port call, a custom object, and so on). For some choices (such as a financial report) an extra dropdown or value appears so you can be specific.
  • Document type (required) — what the template produces and how it's delivered. See Document types.

The template body​

The template body is the text itself. The form shows a read-only preview; click Edit template body to open the editor and write it.

  • The body is written with the templating engine — placeholders like {{ }} and helpers for formatting. That guide is your reference for the language.
  • For an email document type, the body opens in a rich (HTML) editor so you can lay out the message.
  • A handy code-builder button helps you insert the right placeholder for the chosen object definition, so you don't have to remember field codes.

Validity dates​

  • Start date / End date — optional. Use them to control when the template is available — for example to switch a new version on from a certain date, or retire an old one.

Switches​

  • Enabled — turn this on to make the template usable. Leave it off while you're still building.
  • Enable store — keep a stored copy of each produced document with the record.

Save​

Click Save. The template now appears in the overview and, once Enabled, wherever its object definition can be exported or sent.

tip

Build with Enabled off, test it in the Playground, and only switch it on once the output looks right.

Optional settings

Below the core fields is a Template configuration section with many optional, advanced settings. You can save a working template without touching them — see Template configuration when you need them.