Sum loading aid (Manifest)

Event action – Abstract

Purpose: Totals in a manifest the quantity information for one or all Loading aids types in the contained Shipments and writes the sum(s) to loading equipment attributes in the manifest header. For each shipment, all explicit quantities for Loading aids at line item level are added together with the number of loading equipment definitions for the same Loading aids type in the shipment header.


See also: Sum loading aid (Shipment), Loading aids

images/download/attachments/177912391/image-2024-9-18_15-47-24-version-1-modificationdate-1726667243502-api-v2.png

The Sum loading aid (Manifest) event action totals the quantity specifications for one or all Loading aids types in the Shipments contained as manifest items in the reference object of the Manifest type (see Manifests).

For each shipment, all explicit specifications for Loading aids quantities in all item levels are added together with the number of loading aid definitions for the same loading aid category.

The total number for each Loading aids type across all shipments is written to the corresponding loading aid summary attribute in the mandifest header (see Input forms for manifests).

NOTE◄ The calculation is always based on the detailed information given and does not take into account any deviating intermediate results of the Loading aids summary attributes from the header of the shipments. These are also neither supplemented nor updated by the calculation. To ensure that the data status in the Shipments headers is consistent with the total in the manifest, the event action Sum loading aid (Shipment) can be called in a loop over all manifest items if required. It is more elegant to update the summary attributes of each shipment in a separate event handler that is triggered by the "Ändern" Ereignis.

Configuration

images/download/attachments/177912391/image-2024-9-18_15-46-44-version-1-modificationdate-1726667204025-api-v2.png

The event action Sum loading aid (Manifest) expects a manifest as a reference object (see Manifests). In the context of a different object type, the event action has no effect without an error occurring at runtime.

The optional Type parameter can be used to limit the evaluation to a specific Loading aids.

  • If no Type is specified, all Loading aids types that occur in the Shipments manifest line items are added up.

IMPORTANT◄ If no Type is specified, the action updates only the summary attributes of the packaging types that are currently in use. If in previous calculations summary values were calculated for types that currently no longer occur in any of the order items, then these values are retained unchanged. They must be explicitly reset or deleted if necessary.

Example

Whenever Manifests are saved, their Loading aids summary attributes should be updated depending on the Shipments included as manifest items.

Configuration:

  • 'Create' and 'Update' (see Common action event) are selected as Triggering events so that the update of the sum attributes takes place each time 'Save' is performed.


  • The Validating rule uses Check type to ensure that the Actions on passed rule are executed only in the context of a manifest.


The Actions on passed rule are configured as shown on the right:

  • Before calculating the sum attributes for Loading aids, an event action of the Modify list / Clear type deletes all existing attributes of this category, so that after the recalculation, no obsolete information for Loading aids categories that may no longer be relevant is contained in the manifest header (see, 'Important' above). The list is determined by an All attributes of one type value resolver.

  • Subsequently, the event action Sum loading aid (Manifest) is executed with no restrictions for Type, so that a summary is calculated for each Loading aids type that is in use within the shipments included as manifest items.

images/download/attachments/177912391/image2021-7-26_11-32-59-version-1-modificationdate-1726666903062-api-v2.png

Runtime example:

The following example shows an input form for a Manifest, in which only the summary attributes for the Loading aids EURO-Pallet and Box are displayed in the header level of the manifest.

For each manifest line item – i.e. for each individual shipment – the 'loading aid definitions' (with the 'Grid' view type) are listed here, whereby a Barcode is also displayed for each Loading aids in addition to the Type.

NOTE◄ To keep the example simple, it is assumed that the shipment items do not contain any additional information for Loading aids.

images/download/attachments/177912391/image2021-7-26_11-35-32-version-1-modificationdate-1726666903049-api-v2.png

The summary attributes are updated when the manifest is saved. Saving after removing the second manifest position results in the following image:

images/download/attachments/177912391/image2021-7-26_11-34-12-version-1-modificationdate-1726666903053-api-v2.png

NOTE

  • Without explicitly resetting (deleting) all summary attributes for Loading aids in the event handling, the value 1.00 would still appear in the EURO-Pallet field.

  • If the Type 'EURO-Pallet' was explicitly named within the event action Sum loading aid (Manifest), then the value 0.00 would appear in the EURO-Pallet field, since the attribute would then be created but assigned the value 0.