Input forms for shipments

See also: Business Entities and Attributes.

Input forms for shipments can be created with the form designer (see also Form Designer).

Shipments can contain attributes of the following types:

  • Text attributes

  • Numerical attributes

  • Date attributes

  • Indicator attributes

  • Reference attributes

  • Free enumerations

  • Company attributes

  • Address attributes

Shipment header

Additionally, the following specific elements are offered in the form designer:

Section

Element

Type

Content

Shipment

ID

Text field

Unique numeric ID of the shipment within Lobster Data Platform / Orchestration;
automatically assigned upon creation of the shipment, therefore the element should be defined as inactive or read-only

Shipment type

Combobox

Defined via the dynamic enumeration Shipment type

International commercial term

Combobox

Defined via the dynamic enumeration Incoterms

Service type

Combobox

Defined via the dynamic enumeration Service type

Mode of transport

Combobox

Defined via the dynamic enumeration Mode of transport

Number of packages

Text field

Numeric value for the number of packages

Working state

Combobox

Defined via the dynamic enumeration Working state

Line items

Repeatable element

Line items of the shipment with its own configuration (see following sections)

Delivery instruction attributes

Delivery instruction attribute

Repeatable element

Defined via the dynamic enumeration Delivery instruction;
multiple elements of the enumeration can be assigned to the same shipment, by selecting a delivery instruction type per Combobox.
Depending on the configuration per type (in dynamic enumeration), a Text field is available for input details;
restrictions for permitted combinations of delivery instructions can be controlled by Delivery instruction combinations

Elements per Delivery instruction

Column layout

Elements of the dynamic enumeration Delivery instruction can also be added as individual elements in a form.
The type of Delivery instruction appears as a label of a Column layout container with a Text field that is visible depending on configuration in the enumeration.
Delivery instructions that are explicitly included in a form are automatically created, when the shipment is saved

Loading aid summary attribute

Elements per Loading aids

Column layout

For each element of the dynamic enumeration Loading aids, a loading aid summary attribute is available.
The Column layout container provided features a Text field for calculation results (see Sum loading aid (Shipment)

Packaging summary attribute

Elements per Type of packaging

Column layout

For each element of the dynamic enumeration Type of packaging, a packaging summary attribute is available.
The Column layout container provided features a Text field to indicate the calculated results (see Sum packaging (Shipment))

Loading aid definition

Loading aid definition

Repeatable element

Multiple loading aid definitions can be assigned to the same shipment, including an indication of 'Type' (Combobox for Loading aids) and a Text field 'Barcode')

Shipment line items

On the level of line items of a shipment, i.e. inside a shipment line item element, the following specific content is available:

Section

Element

Type

Content

Shipment line item

Line item no.

Text field

Systematic line item number of the current line item.
Automatically assigned on create/update with a hierarchical structure (see Line item type)

Parent line item no.

Text field

Systematic line item number of the parent line item.
Automatically assigned on create/update with a hierarchical structure (see Line item type)

Referenced line item

Combobox

Element picks reference from the current line item to a line item of another Line item type (e.g. from Line item type 'Default' to Line item type 'Service') within the same shipment.
When the element is added to a form, target Line item type and level (starting from 0) must be specified

Number of packages

Text field

Numeric value for the number of packages;
also used as input for calculating packaging summaries per Type of packaging on position level (see Sum packaging (Shipment))

Aggregated number of packages

Text field

Numeric value for the aggregation of packages in sub line items (as a product of 'Number of packages' of the sub line item x 'Number of packages' of the parent line item)
(see Calculate attributes down (Shipment))

Type of packaging

Combobox

Defined by the dynamic enumeration Type of packaging;
required input for calculation of packaging summaries per Type of packaging (see Sum packaging (Shipment))

Product search

Expandable
Search ► product

Search (Combobox) for product selection with an expandable section for product data (see also section 'product search' below).
►NOTE◄ Includes the element 'Product', which therefore cannot be selected separately

Product

Row layout ► product

Row layout container for attributes or Products, including Dangerous goods (see below).
►NOTE◄ Not available if 'Product search' is in use

Line items

Repeatable element ► shipment line items

Sub line items of the current line item, which may in turn contain further sub line items.
Line items may be cascaded to build a hierarchy of arbitrary depth, reflected in the systematically assigned 'Line item no.' values

Aggregate numeric attribute

Elements per Numeric types

Column layout

For each element of the dynamic enumeration Numeric types, an aggregate numeric attribute is available.
By default the provided Column layout container contains a Text field for the numeric value and a Combobox for the applicable unit.
Optionally, another numeric Text field 'Aggregate value' is available, to populate with calculated values by Calculate attributes down (Shipment)

Barcode attribute

Barcode attribute

Repeatable element

For each shipment, line item multiple barcodes can be assigned as elements of a plural typed attribute (see Plural attributes).
Each element provides a Column layout container with the Text field 'Barcode' and a Text field 'Barcode reference'.
The Text field 'Barcode' may be populated automatically by Generate barcodes (Shipment) via Number range

Loading aid definition

Quantity

Text field

Numeric value for number of Loading aids of a line item

Type

Combobox

Defined via the dynamic enumeration Loading aids;
defines the category for the calculation of a loading aid summary (see Sum loading aid (Shipment))

Reference

Combobox

Optional reference to an element of loading aid definition in the shipment header;
a dropdown shows a combination of 'Type' and 'Barcode', whereas the internally assigned ID (long) of the element is stored

Linked line item

Elements per (applicable) Verknüpfter Positionstyp

Column layout

A shipment line item may specify one outbound link for each Verknüpfter Positionstyp configured with a source line item type of 'Shipment line item'.
Each link is represented by a Column layout container containing one Combobox to specify the business object to link to an another for one of its line items.
Additionally, a 'Link line items' button can be added (see also Working with 'Linked line items')


Product data (within shipment line item)

Definition of a 'Product Search':

The selection box allows for the editing of service configuration

images/download/attachments/62850072/20-04-_2016_15-35-39-version-1-modificationdate-1603450457857-api-v2.png

Since the product search always returns product entities, no Joins for the Label Expression can be formed.

With the function 'ta' (TypedAttribute function), you can access a product's attributes.

This example refers to the short description:

{$ta(de.lobster.scm.base.product.attributes.ProductDescription,de,shortDescription)}

In so doing, indicate the attribute's class, as well as the language (the name from the enumeration Locale(en)) and the member (shortDescription) of the class.

'ProductDescription' has the members 'shortDescription' and 'longDescription'.

Product data

Products may feature typed attributes of the following types:

  • Text attributes

  • Numerical attributes

  • Indicator attributes

  • Free enumerations

The following elements are specific for product data:

Section

Element

Type

Content

Product

Add to product catalog

Button

Standard procedure for adding the current product to an existing product catalog

Product ID

Product ID

Text field

Multiple 'Product IDs' can be assigned to the same product, as long as they are linked to a unique combination of Product ID context and Product ID type;
for each 'Product ID' Text field this combination must be specified when it is added to a form.
There is no repeatable element to handle 'Product ID' entries across types.
►NOTE◄ There is no check to ensure the added combination of Product ID context and Product ID type in the form is unique. If the same combination is linked to more than one Text field, the same value (at least after saving) will be shown

Product description

Short description
[ <Locale> ]
(one element per Locale)

Text field

Single line of text for locale-specific product description

Long description
[ <Locale> ]
(one element per Locale)

Text field

Potentially multi-line text for locale-specific product description

Price attribute

Price attribute featuring the following details:

  • Net value, Gross value, Tax rate

    • Base value, Base unit

Column layout

Multiple price attributes can be assigned to the same product, provided a unique combination of Price context, Country and Währung is specified;
for each Column layout container added to a form, this combination must be specified.
There is no repeatable element to handle price attributes across types.
►NOTE◄ In contrast to 'Product ID', there is a check if a combination of Price context, Country and Währung is unique within a form.
Each price attribute features Text field elements for 'Net value', 'Gross value' and 'Base value' as well as Combobox elements for 'Base unit' and Tax rate

Dangerous goods attribute

Dangerous goods attribute (see below)

Repeatable element

Multiple dangerous goods attributes can be assigned for the same product, featuring specific attributes (see below) and references to Dangerous goods master data;

Dangerous goods data

For Dangerous goods attributes, the following elements are available:

Section

Element

Type

Content

Dangerous goods attribute

Dangerous substance

Combobox

Configurable search for Dangerous goods (see NOTE below)

Dangerous substance expandable

Expandable

Configurable search for Dangerous goods including an expandable container to indicate the dangerous substance details

Dangerous substance select

Button

Opens an overview of Dangerous goods for the selection dangerous substances

Dangerous substance label

Label

Indicates the 'Name' of a dangerous substance as a label

Inner quantity value

Text field

Numeric value for inner quantity

Inner quantity unit

Combobox

Inner quantity unit

Outer quantity value

Text field

Numeric value for outer quantity

Outer quantity unit

Combobox

Outer quantity unit

NEQ value

Text field

Numeric value for NEQ (net explosives quantity)

NEQ unit

Combobox

Unit of NEQ (net explosives quantity)

Limited quantity

Check box

Flag value

Quantity outer packaging

Text field

Numeric value for the outer packaging quantity

Quantity inner packaging

Text field

Numeric value for the inner packaging quantity

Inner packaging

Combobox

Selection for the inner packaging (see Dangerous goods packaging type)

Hazard-inducing substance

Combobox

Selection for Gefahrauslösender Stoff

Hazard-inducing substance text

Text field

Plain text for the hazard-inducing substance

Recovery package

Check box

Flag value

Recovery pressure vessel

Check box

Flag value

Dangerous for environment

Check box

Flag value

Outer packaging

Combobox

Configurable search for the outer packaging (see Dangerous goods package)

►NOTE◄ Combobox 'Dangerous substance' must be included in a form, when 'Dangerous substance select' (Button) and 'Dangerous substance label' are used. However, the Combobox may be defined as 'invisible'.