Skip to content

Latest commit

 

History

History
110 lines (99 loc) · 6.72 KB

epcisMessageSpecification.md

File metadata and controls

110 lines (99 loc) · 6.72 KB
Raw

EPCIS Message Specification

For all of the following message specifications, the folder EPCIS message examples contains illustrative examples.

EPCIS Events to express the loading and unloading of load carriers

Comments

  • Note: if there are tradable and non-tradable OR several quality levels in the course of an arriving/departing event, we need to generate several EPCIS events.
  • Rationale: these criteria entail different business processes/pallet values. Thus, we have to properly distinguish quantities pertaining to different qualities.
Dim Data Element V1 V2
Description RTIs arrive at a given location RTIs leave a given location
Event Type ObjectEvent ObjectEvent
eventID EPCIS Event Hash ID EPCIS Event Hash ID
action OBSERVE OBSERVE
When eventTime Timestamp of event Timestamp of event
What quantityList
_quantityElement
__epcClass GRAI (without serial number) of RTI GRAI (without serial number) of RTI
__quantity Number of arrived RTIs Number of departed RTIs
Where readPoint SGLN (without GLN extension) of RTI exchange location SGLN (without GLN extension) of RTI exchange location
Why bizStep Arriving (CBV) Departing (CBV)
bizTransactionList
_bizTransactionID type:https://epcis.b4l.com/btt/voucher GDTI of voucher GDTI of voucher
_bizTransactionID type:po (CBV) GDTI or GLN-based URI of purchase order GDTI or GLN-based URI of purchase order
sourceList
_source type:possessing party (CBV) PGLN of delivering LSP n./a.
_source type:owning party (CBV) PGLN of sending exchange party PGLN of sending exchange party
destinationList
_destination type:possessing party (CBV) n./a. PGLN of sending LSP
_destination type:owning party (CBV) PGLN of receiving exchange party PGLN of receiving exchange party
_destination type:location (CBV) n./a. SGLN of receiving exchange location
Other b4l:tradability true or false true or false
b4l:qualityLevel A, B, or C A, B, or C
b4l:licenceNumber String String

EPCIS Events to express a change of ownership (only applicable for open pool systems)

Dim Data Element V3
Description RTIs change ownership from one to another organisation
Event Type ObjectEvent
eventID EPCIS Event Hash ID
action OBSERVE
When eventTime Timestamp of event
What quantityList
_quantityElement
__epcClass GRAI (without serial number) of RTI
__quantity Number of RTIs changing ownership
Why bizStep Accepting (CBV)
bizTransactionList
_bizTransactionID type:inv (CBV) Invoice ID (URI, e.g. GDTI or GLN-based URI)
sourceList
_source type:owning party (CBV) PGLN of releasing exchange party
destinationList
_destination type:owning party (CBV) PGLN of receiving exchange party
Other b4l:qualityLevel A, B, or C

EPCIS Error Declaration Events

Comments

  • The following illustrative example pertains to V1.
  • In case an ordinary arriving, departing or accepting event turns out to be erroneous in retrospect, exchange parties have the option to make use of the 'Error Declaration' Mechanism introduced as of EPCIS 1.2.
  • The Error Declaration (V4) as well as the Corrective Event (V5) SHOULD be captured in one request. The Error Declaration Event looks identical to the original (i.e. incorrect) event, except for the additional Error Declaration Element reversing its semantics. Further, it also accommodates a forward link to the Corrective Event.
  • For more information, see EPCIS v. 1.2, section 7.4.1.2.

EPCIS Event Hash ID

  • For populating the correctiveEventID/eventID field, we apply the EPCIS Event Hash ID as introduced in CBV 2.0
  • Amongst others, the advantage for B4L consists that the latter can (in conjunction with DiGSig) also be used for notarisation for EPCIS events.
  • For more information and a reference implementation (WIP!), see https://github.com/RalphTro/epcis-event-hash-generator
Dim Data Element V4 V5
Description Error Declaration Event Corrective Event
Event Type See original event See original event
eventID EPCIS Event Hash ID (identical to erroneous event) EPCIS Event Hash ID (of the corrective event)
errorDeclaration
_declarationTime Timestamp of error declaration
_reason Incorrect data (CBV)
_correctiveEventIDs
__correctiveEventID EPCIS Event Hash ID
action See original event See original event
When eventTime See original event Possibly corrected Timestamp
What quantityList - quantityElement
epcClass See original event Possibly corrected GRAI (without serial number) of RTI
quantity See original event Possibly corrected number of departed RTIs
Where readPoint See original event Possibly corrected SGLN (without GLN extension) of RTI exchange location
Why bizStep See original event Possibly corrected Business Step
bizTransactionList
bizTransactionID type:https://epcis.b4l.com/btt/voucher See original event Possibly corrected GDTI of voucher
sourceList
source type:possessing party (CBV) See original event Possibly corrected PGLN
source type:owning party (CBV) See original event Possibly corrected PGLN
destinationList
destination type:possessing party (CBV) See original event Possibly corrected PGLN
destination type:owning party (CBV) See original event Possibly corrected PGLN
destination type:location (CBV) See original event Possibly corrected SGLN
Other b4l:tradability See original event Possibly corrected true or false
b4l:qualityLevel See original event Possibly corrected A, B, or C
b4l:licenceNumber See original event Possibly corrected String

Legend/explanation

  • owning_party: actual exchange parties (in open pool system systems the actual owner, in closed pool systems the 'lessee')
  • LSP - Logistics Service Provider
  • RTI - Reusable Transport Item
  • GDTI - Global Document Type Identifier
  • GRAI - Global Reusable Asset Identifier
  • SGLN - Global Location Number with or without extension
  • PGLN - Global Location Number of Party