Creating Document Templates
In This Article
This article will explain how to create, edit, and delete Document Templates.
Note
What is a Document Template?
It is is a template used to format data into a document. Logiware uses Microsoft Word to create document templates.
Logiware allows you to create as many templates as you like.
Document Templates help you handle customization for:
- Different SubOrganizations
- Different shipment types and situations
- Specific customer needs
Setup
Document Templates are associated with Document Types.
Some examples of a Document Type are: bill of lading, freight invoice, booking confirmation.
Before creating a Document Template, you will need to make sure the Document Type you need has already been created. If not, you will need to add it in the Common References page.
Setup
You will need to create a Word document to use as the base for your Document Template, and have it ready before you begin the process.
Navigation
Click on Appliction Switcher > Control Panel > Customization > Document Templates
The Document Templates page will appear:
Steps
Uploading a New Document Template
- To create a new Doument Template, click the New button in the upper right corner of the page.
- A drawer will open:
- Enter the following information:
- Product - Select the Product that the document template will be used with.
- Module - Select the Module that the document template will be used with.
- Document Type - Select the type of document for the template.
- Name - Provide the name of the template (what you want to cal lit and how it will appear in the document list).
- Description - Enter a brief description of the template (What is it used for, why is it needed, etc..).
- Press the Next button to continue, or Cancel to return to the previous screen and start over.
- A panel will appear and allow you to drag a Word document
- You can drag your Word document from your computer into the box, or click in the box to select a file from your computer.
- Press the Upload button to continue.
- Once you have uploaded the Word document, you will be returned to the previous page that lists all of the Document Templates, including the one you just uploaded:
Editing and configuring a Document Template
Once you have uploaded your Word document into the Document Templates screen, you can begin editing and configuring the template.
- Click on the More icon (3 dots):
- Next select the View option:
- The Preview Template page will display the template:
- On the left side of the page will be variables from the system that are avaialable to imbed into your Document template:
Navigation within the variables panel
In the Variables Panel, there are 3 tabs to help organize the variables (fields):
- User - variables/fields related to the user
- Organization - variables/fields related to the organization
- Booking - variables fields from the booking
Varible headings are also displayed in the variables panel:
These headings can be expanded to view the varibles under that heading:
- To imbed a variable, first click on the Copy icon of the desired variable:
- Next, place your cursor in the Word document and Paste the variable, where you want it to print:
- When you have placed all the variables needed into your template, then press the Generate button to update the template:
Handling Multi-level variables
- Some variables are involved in multiple level/nested table structures.
For example, in the image below, Container number is included/nested under the FCL Goods table:
- To include multi-level/nested variables, you must include all tags related to the path to get to the variable.
- For the example above, to include the Container Number variable in a document template, you will need to copy 2 variable tags (the FCL Goods tag, {#6b0966b0}, and the FCL_goods Container number tag, {372fcac3}.
- So your document template would need to include the following:
{#6b0966b0}{372fcac3}
- Table level tags that include other variables are notated with a "#" symbol as the first character.
- Once you have opened a table level tag, you can use any variables within it without having to repeat the tag for each variable. So you only need to paster the table level tag once .
- To close a table level tag, you need to include the {/} symbols in the document as shown below:
Highlighted in the blue outlined boxes above are the tags to open a table and highlighted in the red outlined box are the corresponding tag to close the table.
- You cannot leave tables open for more than a single row. You must close all tables by the end of the row of data. See the example above. Three tables are open as identified with the "#" sign in the blue highlighted boxes. Variables can be used anywhere on the row, but by the end of the row, the open table tags must be closed with the "{/}" symbols.