Export File Naming: Difference between revisions
(Added PF Depot to export file naming replacement fields (from 341168 on 04/05/2017).) |
(Added details of POD/POC Images being sent as a separate file.) |
||
Line 49: | Line 49: | ||
* TIME - the time the message is attempted to be sent, in format "HHmmss" | * 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. | * UID - a unique ID for the file being sent in that batch. | ||
{{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. | |||
Line 61: | Line 64: | ||
This is then sent to the configured system by the method indicated. | 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== | ==Scope and Limitations== |
Revision as of 14:15, 22 November 2018
Exports from CALIDUS ePOD in FILE and FTP format may be controlled as to 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, an Export configuration must be created and linked to the Site or Job Group.
The configuration must be method FTP or FILE.
The Filename must be configured.
Operation
When exporting 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 set 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
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: 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
- * - Asterisk
- ? - Question Mark
- " - Quote
- < - Less Than
- > - Greater Than
- | - Vertical Bar