Procedure - Shipment template

Purpose

As an alternative to logic interpreter modules, you can store templates for shipments in LBASE Online and continually re-use or adapt them. However, the shipment templates are part of the LBO Add-On package and subject to a licence.

Shipment templates have the following attributes:

  • To ensure that the templates do not appear in any shipment statistics, they have the status ‘cancelled’ with the status code 900. When deleting a template, the shipment therefore remains as cancelled and only the assignment to each other is deleted.

  • The templates are stored with the defined shipment type from the configuration. Please note that this type can no longer be changed.

  • The template is stored with the current date.

  • The stored templates are automatically assigned to the internet user currently logged in.

Note: in the template, there is no check for two addresses in the shipment description row. This means that during template entry, the pre-populated address type Shipper/Supplier can be deleted in the shipment description row and the template can be edited and saved with only one address (customer). If this template is then loaded, a check takes place and the standard address types (SU and CN) many be suggested as previously for the shipment.

Admin Configuration

sdg_tpl.allowed: the management and use of shipment templates is enabled via the property sdg_tpl.allowed=1. The function is then available in the shipment menu.

 

sdg_tpltyp: this property enables you to store a shipment type that is stored in LBASE under Master data / Tables of shipments / Shipment type.

Shipments with the stored type are excluded during the shipment search and in the drop-down list for standard shipment entry meaning that the type should be created as a global property.

Example: sdg_typltp=XX (global property)

 

sdg_tpl.azaid=9092 (optional): you can store a specific display mode for the table. To do this, you must store a pseudo mask in the LBASE Client under Master data / System administration / Masks to define the display mode.

 

sdg_tpl_saveli (optional): sdg_tpl_saveli=1 can be used to define whether the LI should be started when the shipment is saved as a template. This function is disabled by default.

Note: if this function is enabled, you should ensure that the shipment type is checked in your modules. In this context, one of the three following calls should be enabled for the LI integration:

  • sdg_la_sdg=1

  • sdg_check=1

  • sdg_dfue=1

 

sdg_tpl.fast (optional): setting sdg_tpl.fast=1 enables fast saving. This means that the template table is immediately displayed for entering the next shipment after the shipment has been saved and not when the template is saved. Quick entry is only interrupted if sdg_li_error.show is enabled and errors occur in the LI. This function is disabled by default.

Process

Creating a template and saving as a template

When creating a new template using the Enter new shipment function, a shipment can be stored as a template with a particular name.

Note: when assigning the name, we recommend that you do not use any HTML-specific signs such as <.

Once the name has been entered in the Template designation field and [Save as a template] has been clicked, the shipment can then be saved as usual.

Note: to prevent you from accidentally saving the template as a shipment, the [Save] function is hidden for the shipment.

 

Using templates

Templates can be selected via [Use templates] in the Shipments menu.

A templates table opens displaying all the available templates and enabling new creation and editing on the basis of the template with a click of the mouse.

Tip: if you have previously created a pseudo mask in the LBASE Client, you can also independently define the display mode The display mode describes how the search result should be displayed and is stored in the LBASE Client. for this table.

Example: sdg_tpl.azaid=9092

The following functions are available for your use in the template table:

  • Icon in the 1st column: the template can be edited or deleted.

  • Icon in the 2nd column: the template is copied, i.e. opened as a new shipment. Any text addresses are all duplicated and master addresses/customer addresses are used.

 

Editing a template

A template can be accessed and (re-)edited via the Open function in the first column of the templates table or the Shipments menu.

Admin Note: If the property saveli is enabled, the template can only be accessed for re-editing via the shipment hyperlink, for example in the LI feedback.

 

[Delete template]

You can remove a template by opening the desired template.

You can do this either:

  • via the link for re-editing or

  • by clicking [Use templates], opening the template for editing via the icon in the first column of the templates table and then clicking [Delete template].

A feedback message indicating that the template has been successfully cancelled is then displayed on the main page.

Copying a template

Once you have opened a template by clicking the first icon in the templates table, you can amend the shipment details, enter a new template designation and once again click [Save template].

Tip: the title shows which template you have just opened.

 

Quick entry

Admin  If the property sdg_tpl.fast is enabled, once a shipment has been entered with a template, the templates table can be automatically displayed again.

Tip: if LI validation is enabled (sdg_li_error) and an error occurs, the quick entry process is interrupted.