Event action – Abstract

Purpose: Sums up in a manifest one or all packaging types in the contained Shipments and writes the sum(s) to packing sum attributes in the manifest header.

images/download/attachments/177912416/image-2024-9-18_15-55-6-version-1-modificationdate-1726667706282-api-v2.png

The Sum packaging (Manifest) event action summarizes the quantity information for a specific Type of packaging (or all) in the Shipments contained as manifest items in a reference object of the 'Manifest' type (see Manifests).

The value in the 'Number of packages' field (numberOfPackages) and not the 'Aggregate number of packages' field (aggregateNumberOfPackages) is crucial for the imputation on the level of the respective line item.

CAUTION If the 'Aggregated number of packages' is calculated for a Line item type, e.g. with the event action Calculate aggregate number of packages, in order to cascade the number of packages in sub-items in a multi-level line item hierarchy, this leads to inconsistencies in the calculation of packaging totals for each Type of packaging that occurs in these sub-items..

The total number per packaging type over all Shipments is written to the corresponding packaging summary attribute in the manifest header (see Input forms for manifests).

There are corresponding event actions for Orders (Sum packaging (Order)) and Shipments (Sum packaging (Shipment)). In configurations, the 'matching' event action must always be used for the reference object in question. To avoid confusion, no error message occurs at runtime. The calculation just does not return a result.

►NOTE◄ The calculation is always based on the detailed data given and does not take into account any deviating intermediate results from the packaging 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 shipment headers is consistent with the total in the manifest, the event action Sum packaging (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/177912416/image-2024-9-18_15-55-40-version-1-modificationdate-1726667740319-api-v2.png

The event action Sum packaging (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 Type of packaging.

If no Type is specified, all Type of packaging 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 packing 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 'Packaging summary attribute', 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 any 'packaging materials' 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 packaging (Manifest) is executed with no restrictions for Type, so that a summary is calculated for each Type of packaging that is in use within the shipments included as manifest items.

images/download/attachments/177912416/image2021-7-26_15-42-5-version-1-modificationdate-1726667560190-api-v2.png

Runtime example:

The following example shows an input form for a Manifest in which the 'Packaging summary attribute' per Verpackungstyp (configured here: Hobbock and Sack) appear in the header level of the purchase order.

Within the Manifest line item, several line items, possibly with sub-items, can be seen for each Shipment, for which a Number of packages can be specified in each case in connection with a Type of packaging.

►NOTE◄ For the sub-items in the example, the convention is that the Number of packages field indicates the absolute number of packages of the packaging type in question and not the number of packages within each package in the higher level. Specifically, for Line Item no. 2 in the 2nd manifest item, this means that there are a total of 36 bags in 3 barrels. Whether this is 12 bags per barrel is thus not explicitly defined.

images/download/attachments/177912416/image2021-7-26_15-43-2-version-1-modificationdate-1726667560181-api-v2.png

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

images/download/attachments/177912416/image2021-7-26_15-43-38-version-1-modificationdate-1726667560178-api-v2.png

►NOTE◄

Without explicitly resetting (deleting) all packaging sum attributes in the event handling, the value 1 would still appear in the Barrel field.
If the Type 'Barrel' was explicitly named within the event action Sum packaging (Manifest), then the value 0 would appear in the Barrel field, since the attribute is then created but assigned the value 0.