gs1 / EPCIS

Draft files being shared for EPCIS 2.0 development
Other
22 stars 7 forks source link

Move EPCIS MasterData from EPCIS Header to EPCIS Event standard extension #184

Closed CraigRe closed 3 years ago

CraigRe commented 3 years ago

On 16 February call, the group acknowledged that EPCIS specifies no standardised means of either capturing or querying EPCIS Master Data ( EPCISMasterData ) from an EPCISMasterDataDocument, and agreed that that EPCIS 2.0 should remove references to the EPCISMasterDataDocument.

At the same time, EPCIS currently specifies no standardised means of querying EPCISMasterData included in the EPCISHeader of a captured EPCISDocument, and @mgh128 has reiterated concerns the issue of reliable mechanisms of correcting / updating EPCISMasterData transmitted via the EPCISHeader (i.e., due to the need to rely on the SBDH's CreationDateAndTime in place of EPCIS eventTime for chronological sequencing).

For this reason, with regard to the XML binding of EPCIS 2.0, the workgroup should discuss the possibility of moving EPCISMasterData from EPCISHeader to the EPCIS standard extension area, within the second element that is nested within the first element (i.e., like AssociationEvent, sensorElementList and persistentDisposition), to maintain backward compatibility with EPCIS 1.x.

(The extension wonkiness of xml is, of course, completely avoided with the JSON-LD binding.)

Advantages include: • Migration from the wonky, non-queryable EPCISHeader to • Accessible MD that, like ILMD, can be queried • Ability to use eventTime to determine most recently posted MD details

jeanneduckett commented 3 years ago

Make sense

On Mon, Feb 22, 2021 at 7:35 AM Craig Alan Repec notifications@github.com wrote:

On 16 February call, the group acknowledged that EPCIS specifies no standardised means of either capturing or querying EPCIS Master Data ( EPCISMasterData ) from an EPCISMasterDataDocument, and agreed that that EPCIS 2.0 should remove references to the EPCISMasterDataDocument.

At the same time, EPCIS currently specifies no standardised means of querying EPCISMasterData included in the EPCISHeader of a captured EPCISDocument, and @mgh128 https://github.com/mgh128 has reiterated concerns the issue of reliable mechanisms of correcting / updating EPCISMasterData transmitted via the EPCISHeader (i.e., due to the need to rely on the SBDH's CreationDateAndTime in place of EPCIS eventTime for chronological sequencing).

For this reason, with regard to the XML binding of EPCIS 2.0, the workgroup should discuss the possibility of moving EPCISMasterData from EPCISHeader to the EPCIS standard extension area, within the second element that is nested within the first element (i.e., like AssociationEvent, sensorElementList and persistentDisposition), to maintain backward compatibility with EPCIS 1.x.

(The extension wonkiness of xml is, of course, completely avoided with the JSON-LD binding.)

Advantages include: • Migration from the wonky, non-queryable EPCISHeader to • Accessible MD that, like ILMD, can be queried • Ability to use eventTime to determine most recently posted MD details

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/gs1/EPCIS/issues/184, or unsubscribe https://github.com/notifications/unsubscribe-auth/AKB3UZDP6COP5HAS4YBKAXTTAJFSXANCNFSM4YAOB2YQ .

--


The information transmitted is intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you received this in error, please contact the sender and delete the material from any device.

For details about the personal information we process and why, please see our Privacy Notice https://www.averydennison.com/en/home/legal-and-privacy-notices.html


CraigRe commented 3 years ago

New standard MD extension has been taken off the table in favour of something more forward-facing, leveraging Linked Data; @mgh128 is drafting a 1-2 pager describing a GS1 DL-based, forward-looking approach.

joelvogt commented 3 years ago

HI @CraigRe. What does it mean for the REST API specs, do we keep the queries endpoint or remove it? Or do we keep the queries endpoint and return master data in the header of an EPCISQueryDocument?

CraigRe commented 3 years ago

@joelvogt , on the 23 Feb call, the group agreed (tentatively) to remove: /queries/SimpleMasterDataQuery /queries/SimpleMasterDataQuery/masterData

The discussion has not yet been closed; the group still needs to decide whether to explicitly omit Master Data (i.e., as optionally, clumsily, transported in the EPCIS Header) from the JSON/JSON-LD bindings in EPCIS 2.0.

CraigRe commented 3 years ago

Agreed on 16 March:

image