CBV-Compatible and CBV-Complaint documents

[axman6]

The section 5 of CBV documentation has identified the standard of the CBV-Complaince and CBV-Comaptibility documents. I think we can to implement it, after we have the document/event ready. as it contains lots of constraints about the input/output of the document, and the URI.

I will keep this issue opened, and summarise the conditions in the comments as follows.

Original Author: zz-zhu020

(Moved with github-migration-0.1.0.0 (package github-migration-0.1.0.0 revision df9f38b))

[axman6]

CBV-Compliant

• CBV-Compiant: An EPCIS doc that only uses vocabulary identifiers specified in the CBV standard in the standard field of EPCIS events

A document is CBV-Compliant if it meets

• If in the mode accept CBV-Compliant doc as input, the application SHALL accept any CBV-compliant doc, and SHALL interpret each CBV identifier according to the meaning specified herein
• If in the mode output CBV-Compliant doc, the application SHALL only produce doc that is CBV-complaint, and further generating output SHALL only use CBV identifiers to denote their meaning

CBV-Complaint Document

• CBV-Complaint Document SHALL conform to the schema and other contraints specified in EPCIS 1.2
• CBV-Complaint Document SHALL NOT use any URI beginning with urn:epcglobal:cbv: except as specified in this standard
• Each EPCIS event in a CBV-Compliant Document SHALL include a bizStep field, and the value of the bizStep SHALL be a URI consisting of the prefix urn:epcglobal:cbv:bizstep: followed by the string specified in the first column of some row of the table in (CBV 7.1.3)
  • The _BizStep_s are listed in 7.1.3
• CBV-Compliant document MAY include a disposition field
  • If disposition is present, then the value of disposition field SHALL be a URI consisiting of the prefix urn:epcglobal:cbv:disp:
  • The _Disposition_s are listed in 7.2.3
• Each EPCIS event MAY include one or more bizTransaction elements.
  • If bizTransaction elements are present, each such element MAY include a type attribute
  • If bizTransaction includes a type attribute, then the value of type attribute SHALL be a URI with prefix urn:epcglobal:cbv:btt:
  • The _BizTransaction_s are listed in 7.3.3
• Each EPCIS event MAY include one or more source and desitnation elements
  • The value SHALL be URI with prefix urn:epcglobal:cbv:sdt:
  • The body strings are listed in 7.4.3
• Each EPCIS event MAY include an ErrorDeclaration element
  • ErrorDeclaration element MAY include a reason field
  • reason field SHALL be a URI consisting of the prefix urn:epcglobal:cbv:er:
• 8.1.1 has the contraints on the URI
• All the non-null fields of the instance-level identifiers in the "what" dimension SHOULD use the EPC URI form as specified in 8.2.1
• SHALL NOT use SGLN EPC urn:epc:id:sgln: as an object identifier
• SHALL use one of the 3 URI forms specified in 8.3 to populate class-level ID in "what" dimension
  • EPC URI for class-level identification of objects
  • Private or Industry-wide URN for Class-level identification
  • HTTP URLs for Class-level identification of objects
• SHALL use one of the 4 URI forms specified in 8.4 to populate "where" dimension, for all the non-null readPoint and businessLocation fields in all EPCIS event types
  • EPC URI for Location Identifiers (SHOULD use this one)
  • SHOULD use SGLN urn:epc:id:sgln
  • Private or Industry-wide URN for Location Identifiers
  • HTTP URLs for Location identifiers
  • Geographic Location URIs for Location Identifiers
• SHALL use one of the 4 URI forms specified in 8.5 to populate the business transaction identifier field
  • EPC URI for Business transaction identifiers
  • SHOULD use GDTI EPCs urn:epc:id:gdti: and GSRN EPCs urn:epc:id:gsrn
  • GLN-based identifier for legacy system business transaction
  • Private or Industry-wide URN for business transaction identifier
  • HTTP URLs for business transaction identifier
• SHALL use one one of the 3 URI forms specified in 8.6 to populate source and destination identifier field
  • EPC URI for Source/Destination identifiers
  • SHOULD use SGLN urn:epc:id:sgln
  • Private or Industry-wide URN for Source/Destination Identifiers
  • HTTP URLs for Source/Destination Identifiers
• SHALL use one of the 4 URI forms specified in 8.7 to populate transaction identifier field
  • EPC URI for Transformation identifiers
  • SHOULD use GDTI EPCs urn:epc:id:gdti:
  • GLN-based identifier for Legacy System Transformation identifier
  • Private or Industry-wide URN for Transformation Identifiers
  • HTTP URLs for Transformation Identifiers
• SHALL use the URI form specified in 8.8.1 to populate event identifier field
  • UUID URIs for Event identifier
  • Example: urn:uuid:f81d4fae-7dae-129a-143e-020f92ab4c1

Original Author: zz-zhu020

[axman6]

The common URI follows the standard closely. The EPC also provides a flexible format that some dirty string can be used as well.

Original Author: zz-zhu020