Export File Naming

From EPOD
Revision as of 12:03, 20 June 2025 by Anw (talk | contribs) (Categorisation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

When the system automatically exports a file in FILE and FTP format, the users can control how the files are named.

This includes (but is not limited to):

  • POD exports to Document Management Systems.
  • XML exports of Job or Load completion.
  • Pallet Network exports.
  • Bespoke exports.


Prerequisites

The CALIDUS ePOD server host must have access to the destination.


Configuration

To enable the functionality, the system must be configured with an Export configuration, linked to the site or job group.

The configuration must be method FTP or FILE.

The Filename must be configured.


Operation

When the system exports the file, this is initially produced with the Job ID as the file name, plus the extension as required. For example:

  • [EPL_JOB_ID].pdf.
  • [EPL_JOB_ID].xml.
  • [EPL_JOB_ID].jpg.
  • [EPL_JOB_ID].tiff.


If the users configure the interface to FTP or FILE transfer, the application checks the configuration of the FILENAME parameter. This can contain plain text, plus certain job-level information and standard identifiers. All identifiers are to be placed in parentheses e.g. (DATE).

The following identifiers are replaced with the trimmed data in the field if present, otherwise "0":

  • EPL_EXT_REF.
  • EPL_OWNER_NAME.
  • EPL_SO_NUMBER.
  • EPL_CUST_REF.
  • EPL_CUSTOMER_CODE.

The following are replaced directly with the untrimmed data in the field:

  • EPL_SITE_ID.
  • EPL_JOB_ID.
  • EPL_LOAD_ID.
  • EPL_JOB_CODE.
  • EPL_PF_DEPOT.
  • EPL_STATUS.
  • EPL_AMENDED_FLAG.

General parameters:

  • DATE - the date the message is attempted to be sent, in format "yyyyMMdd".
  • TIME - the time the message is attempted to be sent, in format "HHmmss".
  • UID - a unique ID for the file being sent in that batch.


Note Note: If the POD/POC export is split into separate POD/POC and Image documents (a parameter when creating the POD report), then the Image document is named as the POD/POC report, but with "_images" appended before the extension.


Examples:

Filename:

POD_(EPL_JOB_CODE)_(DATE)_(TIME)_(UID).pdf

would result in the following file name for Job Code "XYZ" send around 1030 on 30/11/2016:

POD_XYZ_20161130_103112_1.pdf

This is then sent to the configured system by the method indicated.

If the POD/POC is set to split images, the two files sent are:

POD_XYZ_20161130_103112_1.pdf
POD_XYZ_20161130_103112_1_images.pdf

Scope and Limitations

Special characters may not be used either in the literal portion of the file-name string or the data inserted:

  • ( - Open Parenthesis.
  • ) - Close Parenthesis.
  • \ - Backslash.
  • / - Forward Slash.
  • : - Colon.
  • * - Asteris.k
  • ? - Question Mark.
  • " - Quote.
  • < - Less Than.
  • > - Greater Than.
  • | - Vertical Bar.