Tracking state code

Value resolver – Abstract

Purpose: Returns the tracking state code value statically determined by single selection in the configuration.

images/download/attachments/177910585/image-2024-9-11_14-42-9-version-1-modificationdate-1726058529095-api-v2.png

The Tracking state code value resolver returns the tracking state code value statically determined by single selection in the configuration. The return value is a TrackingStatusCode object with the following structure.

<baseTS:TrackingStatusCode xmlns:baseTS="SCM.BASE.TS" mode="..." state="..." reason="..."/>

The input value for the value resolver is ignored.

Background information

Tracking state codes result from the definition of Tracking state, which specify a combination of 'mode', 'state' and 'reason' in the 'code' (code) field.

Unlike Working state, which is defined via a dynamic enumeration, the selection for tracking state codes results from the creation of Master data for entities of the type 'Tracking state' (TrackingStatus), which can be assigned to an owner (ownerId). The access to tracking state codes in the context of the Tracking state code value resolver is thereby bound to the read access for Tracking state, which refer to the corresponding code.

Configuration

images/download/attachments/177910585/image2023-1-4_17-26-53-version-1-modificationdate-1726039642574-api-v2.png

The single Tracking state code parameter requires a static selection from the list of tracking state codes available in the context of the configuration, for which a search function is provided.

  • All tracking state codes from master data objects of the Tracking state type for which read access exists within the session used for configuration appear in the dropdown.

  • In the context of a role that observes 'owner restrictions', these are all a Tracking state that the Company of session owns and all are applicable to the Company authorizations that entitle it to 'read'.

  • If the Role of session categorically does not have read access for a Tracking state, the dropdown appears empty.

NOTETracking state access restrictions only affect the context of the configuration. They have no influence on the runtime behaviour of existing configurations.

Selectable options are identified via the localization text, as far as the Localization or Company specific localization, if applicable, provide corresponding localizations.

  • For non-localized tracking state codes, the concatenation of tracking state features appears according to the scheme {mode}|{state}|{reason}(see Tracking state), which also specifies the resource name in the trackingStatus bundle for localization.

Example

This association criterion matches when the current Tracking state is found in a list of defined codes:

images/download/attachments/177910585/image2018-12-10_17-33-35-version-1-modificationdate-1726039642591-api-v2.png

  • On the left, there are two steps from the 'current tracking state' of the shipment to the tracking state code via the tracking state entry.

  • An In list matcher compares the result against a list defined by an Create list resolver based on two discrete tracking state codes 'Shipment ready' and 'Pickup ready'.

NOTE◄ The phrase 'current tracking state' of the shipment here refers to the tracking state code of the tracking state entry referenced in the tracking state attribute for the tracking state type 'Current' (CURRENT).