cbv 1.0 conformance requirements

28
Copyright ©2009, 2010 EPCglobal ® , All Rights Reserved. Page 1 of 28 1 Core Business Vocabulary (CBV) 1.0 Specification 2 Conformance Requirements and Test Plan 3 Document 4 05 October 2010 5 Version 1.0 6 7 Copyright ©2009, 2010 EPCglobal ® , All Rights Reserved. 8 9 REVISION HISTORY: 10 Version No. Date Author Modifications 1 10-13- 2009 Arun Badami Met Labs First final draft conformance requirements and test plans 2 10-05- 2010 Gena Morgan EPCglobal Added references, format changes 11

Upload: phamngoc

Post on 01-Jan-2017

226 views

Category:

Documents


2 download

TRANSCRIPT

Page 1: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 1 of 28

1

Core Business Vocabulary (CBV) 1.0 Specification 2

Conformance Requirements and Test Plan 3

Document 4

05 October 2010 5

Version 1.0 6

7

Copyright ©2009, 2010 EPCglobal®, All Rights Reserved. 8

9

REVISION HISTORY: 10

Version

No.

Date Author Modifications

1 10-13-

2009

Arun Badami – Met Labs First final draft – conformance requirements and test

plans

2 10-05-

2010

Gena Morgan – EPCglobal Added references, format changes

11

Page 2: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 2 of 28

12

Abstract 13

This document outlines the approach to conformance testing for the EPCglobal Core 14

Business Vocabulary (CBV) 1.0 Specification. 15

Status of this document 16

This section describes the status of this document at the time of its publication. Other 17

documents may supersede this document. The latest status of this document series is 18

maintained at the EPCglobal. This document has been reviewed by the working group 19

and is in its final form of delivery to EPCglobal. 20

21

Page 3: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 3 of 28

22

Table of Contents 23

1 Functional Requirements.............................................................................................. 4 24

1.1 Mandatory Requirements Matrix ........................................................................... 4 25

1.2 Optional Requirements Matrix ............................................................................ 11 26

2 Test Case Requirements ............................................................................................. 16 27

2.1 Test Case Requirement 1 – .................................................................................. 16 28

3 References .................................................................................................................. 28 29

30

31

1.1 Terminology 32

Shall is required 33

SHALL/SHALL-NOT statements constitute the mandatory requirements 34

for CBV Compliance/Compatibility. 35

Inability to meet a “SHALL” requirement will be flagged as a Failure to 36

CBV Compliance or CBV Compatibility. 37

Should is recommended 38

SHOULD/SHOULD-NOT statements constitute the optional 39

recommendations for CBV Compliance/Compatibility. 40

Inability to meet a “SHOULD” requirement will be flagged as a Warning 41

to CBV Compliance or CBV Compatibility 42

If there is a condition attached such as SHALL statement, then a SHALL 43

rule will prevail. 44

May is permitted 45

MAY/MAY-NOT statements constitute the optional recommendations for 46

CBV Compliance/Compatibility. 47

Inability to meet a “MAY” requirement is treated as optional and will not 48

be flagged.49

Page 4: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 4 of 28

50

2 Functional Requirements 51

52

2.1 Mandatory Requirements Matrix 53

The following table outlines the mandatory requirements for an EPCIS implementation as 54

defined by the EPCIS 1.0 Specification. 55

56

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

M1

A CBV-Compliant Document SHALL conform to the schema and other constraints specified in [EPCIS1.0.1].

323 Compliant 1

M2

A CBV-Compatible Document SHALL conform to the schema and other constraints specified in [EPCIS1.0.1].

370 Compatible 1

M3

A CBV-Compliant Document SHALL NOT use any URI beginning with urn:epcglobal:cbv: except as specified in this specification.

325 Compliant 2,3,4

M4

A CBV-compatible document SHALL NOT use any URI beginning with urn:epcglobal:cbv: except as specified in this specification.

387 Compatible 2,3,4

M5

Each EPCIS event in a CBV-Compliant Document SHALL include a bizStep field.

327 Compliant 2

M6

The value of the bizStep field 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 7.1.2 Element Values and Definitions – Business Step: “accepting,arriving,commissioning,decommissioning,departing,destroying,encoding,entering_exiting,holding,inspecting,killing,loading,other,packing,picking,receiving,repackaging,reserving,retail_selling,shipping,staging_outbound,stocking,storing”

327, 488 2

Page 5: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 5 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

M7

A CBV-Compliant Document MAY include a disposition field. If the disposition field is present, the value of the disposition field SHALL be a URI consisting of the prefix urn:epcglobal:cbv:disp: followed by the string specified in the first column of some row of the table in 7.2.2 Element Values and Definitions – Dispositions: “active,container_closed,destroyed,encoded,inactive,in_progress,in_transit,non_sellable_expired,non_sellable_damaged,non_sellable_no_pedigree_match,non_sellable_other,non_sellable_recalled,reserved”

331, 534 Compliant 3

M8

Each EPCIS event in a CBV-Compliant Document MAY include one or more bizTransaction elements. If bizTransaction elements are present, each such element MAY include a type attribute. If a given bizTransaction element includes a type attribute, the value of the type attribute SHALL be a URI consisting of the prefix urn:epcglobal:cbv:btt: followed by the string specified in the first column of some row of the table in 7.3.2 Element Values and Definitions – Business Transaction Types: “po,poc,bol,inv,rma,pedigree,de,idlv,odlv,whr,who,shipr,ship,shipo,bookingorder,so,soc,pi,pd,pdc,svo,svoc,mto”

335, 558 Compliant 4

M9

Both CBV-compliant and CBV-compatible documents MAY contain URIs that do not begin with urn:epcglobal:cbv:, provided that the requirements specified elsewhere in this specification are met. These SHALL be used to identify vocabulary elements not defined by the CBV specification

429 Compatible 5

M10

URIs defined in the EPC Tag Data Standard SHALL only be used in a CBV-Compliant Document as specified in 8.1.1 General Considerations for EPC URIs as User Vocabulary Elements

341 Compliant 5

Page 6: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 6 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

M11

URIs defined in the EPC Tag Data Standard SHALL only be used in a CBV-Compatible Document as specified in Section 8.1.1 General Considerations for EPC URIs as User Vocabulary Elements.

389 Compatible 5

M12

Both CBV-Compliant and CBV-Compatible documents SHALL use an EPC Pure Identity URI…All other URI forms are non-compliant and non-compatible

620 {8.1.1}

Both 5

M13

In particular, documents SHALL NOT use EPC Tag URIs (urn:epc:tag:…) , EPC Pure Identity Pattern URIs (urn:epc:idpat:…), or EPC Pattern URIs (urn:epc:pat:…).

625 {8.1.1}

Both 5

M14

Both CBV-Compliant and CBV-Compatible documents MAY use EPC Raw URIs (urn:epc:raw:…) as defined in [TDS1.4], Section 4.2.2, and [TDS1.5], Section 12, provided that the raw value cannot be decoded as an EPC.

629 {8.1.1}

Both 5

M15

Both CBV-Compliant and CBV-Compatible documents SHALL NOT use an EPC Raw URI representing EPC memory bank contents that could be successfully decoded into an EPC Pure Identity URI according to [TDS1.4] or [TDS1.5].

632 {8.1.1, Clarity?}

Both 5

M16

URNs as Vocabulary elements: CBV-Compliant document or CBV-Compatible document MAY use a private or industry-wide URN as specified below. A Private or Industry-wide URI SHALL have the following form: urn:URNNamespace:**:qual:Remainder

646 {8.1.2}

Both 5

M17

HTTP URLs as Vocabulary elements CBV-Compliant document or CBV-Compatible document MAY use an HTTP URL. An HTTP URL SHALL have the following form: http://[Subdomain.]Domain/**/qual/Remainder

660 {8.1.3}

Both 5

Page 7: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 7 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

M18

A CBV-Compliant document SHALL use one of the three URI forms specified in Section 8.2 to populate the “what” dimension of EPCIS events (that is, the epcList, parentID, and childEPCs fields in EPCIS ObjectEvents, AggregationEvents, and TransacationEvents), for every such field that is not null.

343, 674 {8.2 Physical Objects}

Compliant 6

M19

Both CBV-Compliant and CBV-Compatible documents SHALL NOT use an SGLN EPC (urn:epc:id:sgln:…) as a physical object identifier.

359, 387, 691 {8.2.1 EPC URI Physical Objects}

Both 6

M20

Both CBV-Compliant and CBV-Compatible documents SHALL NOT use any of the other URI forms for EPCs defined in [TDS1.4] or [TDS1.5]; see Section 8.1.1 for details.

693 {8.2.1 EPC URI Physical Objects}

Both 6

M21

A Private or Industry-wide URI suitable for populating the epcList, parentID, and childEPCs fields of EPCIS events SHALL have the following form: urn:URNNamespace:**:obj:Objid

703 {8.2.2 Private URN Physical Objects}

6

M22

An HTTP URL suitable for populating the epcList, parentID, and childEPCs fields of EPCIS events SHALL have the following form: http://[Subdomain.]Domain/**/obj/Objid

721 {8.2.3 HTTP URL Physical Objects}

6

M23

A CBV-Compliant document SHALL use one of the three URI forms specified in Section 8.3. to populate the “where” dimension of EPCIS events (that is, the readPoint and businessLocation fields in all EPCIS event types), for every such field that is not null.

351, 734 {8.3 Locations}

Compliant 7

M24

Both CBV-Compliant and CBV-Compatible documents SHALL NOT use any of the other URI forms for EPCs defined in [TDS1.4] or [TDS1.5]; see Section 8.1.1 for details.

750 {8.3.1 EPC URI for Locations}

Both 7

Page 8: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 8 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

M25

A Private or Industry-wide URI suitable for populating the readPoint and businessLocation fields in all EPCIS event types SHALL have the following form: urn:URNNamespace:**:loc:Locid

759 {8.3.2 Private URN for Locations}

7

M26

An HTTP URL suitable for populating the readPoint and businessLocation fields in all EPCIS event types SHALL have the following form: http://[Subdomain.]Domain/**/loc/Objid

777 {8.3.3 HTTP URL for Locations}

7

M27

A CBV-Compliant document SHALL use one of the four URI forms specified in Section 8.4 to populate the business transaction identifier field (that is, the text content of the bizTransaction element) of EPCIS events, for every such field that is not null.

359, 797 Compliant 8

M28

If the goal is to communicate a business transaction identifier and to indicate its type, and furthermore the type is not one of the CBV standard types specified in Section 7.3., the BTI is included, and some URI that does not begin with urn:epcglobal:cbv:… is included as the BTT. (This is CBV-Compatible but not CBV-Compliant.)

808 {8.4} Both 8

M29

A GLN-based URI suitable for use as a business transaction identifier in all EPCIS event types SHALL have the following form: urn:epcglobal:cbv:bt:gln:transID Check Line 841 Tables for format and length

839 {8.4.1}

Both 8

M30

A private or industry-wide URN suitable for use as a business transaction identifier in all EPCIS event types SHALL have the following form: urn:URNNamespace:**:bt:transID Check Line 865 Tables for format and length

851 {EPC URI for bti}

Both 8

M31

An HTTP URL suitable for use as a business transaction identifier in all EPCIS event types SHALL have the following form:

866 {8.4.4}

Both 8

Page 9: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 9 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

http://[Subdomain.]Domain/**/bt/transID

M32

Both CBV-Compliant and CBV-Compatible documents SHALL NOT use any of the other URI forms for EPCs defined in [TDS1.4] or [TDS1.5]; see Section 8.1.

823 {EPC URI for bti}

Both 6, 7, 8

M33

Location Master Data Attributes Constraints as per table lines 922

922 {9.1 Loc MDA Constraints}

9

M34

Location Master Data Names as per table, Lines #926

926 {9.2 Location Master Data Names}

9

M35

When the location identifier is an SGLN EPC, the value of the corresponding Site Location master data attribute SHALL be the 13-digit GLN implied by the company prefix and location reference components of that SGLN. When the location identifier is some other URI, the value of the corresponding Site Location master data attribute

942 {9.3.1 Site Location}

9

M36

The value of the Sub-Site Location Type master data attribute for a location identifier, if present, SHALL be one of the codes in the following table: See table , lines #951

952 {9.3.2 Sub Location Type}

9

M37

The value of the Sub-Site Location Type Attributes master data attribute for a location identifier SHALL be a string consisting of zero or more of the codes in the following table, separated by commas with no leading, trailing, or internal whitespace characters. If the value of the Sub-Site Location Type Attributes master data attribute includes more than one code, the codes SHALL appear in ascending numerical sequence reading from left-to-right. See table, Lines #972.

955 {9.3.3 Sub Location Type Attributes}

9

M38

The value of the Sub-Site Detail master data attribute for a location identifier, if present, SHALL be any

966 {9.3.4 Sub

9

Page 10: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 10 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#1

Compliance /

Compatibility /

Both

TCR

How Verified

(by Demonstration or

by Design)

string of up to 128 characters in length.

Location Type Details}

M39

The Location Description field is intended to describe a location using natural language, and as such, doesn’t prescribe specific values. However, this field SHALL be limited to ASCII characters and a length of 128.

969 {9.3.5 Location Description}

9

57

58

Page 11: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 11 of 28

59

2.2 Optional Requirements Matrix 60

The following table outlines those functional requirements that are defined as optional by 61

the EPCIS 1.0 Specification 62

Optional SHOULD 63

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#2

Area

How Verified

(by Demonstration or

by Design)

OS1

To populate the “what” dimension of EPCIS events (that is, the epcList, parentID, and childEPCs fields in EPCIS ObjectEvents, AggregationEvents, and TransacationEvents) -- A CBV-Compliant document SHOULD use the EPC URI form as specified in Section 8.2.1-3. unless there is a strong reason to do otherwise.

343 Optional

OS2

To populate the “where” dimension of EPCIS events (that is, the readPoint and businessLocation fields in all EPCIS event types) -- A CBV-Compliant document SHOULD use the EPC URI form as specified in Section 8.3.1-3. unless there is a strong reason to do otherwise.

351 Compliant

OS3

When using an EPC URI as a location identifier (Section 8.3.1), a CBV-Compliant document SHOULD NOT use EPC schemes other than SGLN (urn:epc:id:sgln:…), unless there is a strong reason to do so.

356 Compliant

OS4

When using an EPC URI as a business transaction identifier, a CBV-Compliant Documents SHOULD NOT use EPC schemes other than GDTI EPCs (urn:epc:id:gdti:…) or GSRN EPCs (urn:epc:id:gsrn:…), unless there is a strong reason to do so. GDTI EPCs SHOULD only be used as business transaction identifiers when they have been assigned to denote a business transaction, rather than a physical document not

363 {8.4.1}

Compliant

Page 12: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 12 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#2

Area

How Verified

(by Demonstration or

by Design)

connected with any business transaction.

OS5

A CBV-Compatible document SHOULD use the EPC URI form as specified in Section 8.2.1 for each physical object identifier unless there is a strong reason to do otherwise.

391 Compatible

OS6

A CBV-Compatible document SHOULD use the EPC URI form as specified in Section 8.3.1 for each location identifier unless there is a strong reason to do otherwise.

396 Compatible

OS7

When using an EPC URI as a location identifier (Section 8.3.1), a CBV-Compatible document SHOULD NOT use EPC schemes other than SGLN (urn:epc:id:sgln:…), unless there is a strong reason to do so.

399 Compatible

OS8

When using an EPC URI as a business transaction identifier, a CBV-Compatible Documents SHOULD NOT use EPC schemes other than GDTI EPCs (urn:epc:id:gdti:…) or GSRN EPCs (urn:epc:id:gsrn:…), unless there is a strong reason to do so. GDTI EPCs SHOULD only be used as business transaction identifiers when they have been assigned to denote a business transaction, rather than a physical document not connected with any business transaction.

402 Compatible

OS9

Both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form as specified in Section 8.2.1 unless there is a strong reason to do otherwise.

678 {8.2 Physical Objects}

Both

OS10

A CBV-Compliant document or CBV-Compatible document MAY use an EPC Pure Identity URI as specified in Section 8.1.1 to populate the epcList, parentID, and childEPCs fields in EPCIS ObjectEvents, AggregationEvents, and TransacationEvents. Both CBV-Compliant and CBV-Compatible documents SHOULD

685 {8.2.1 EPC URI Physical Objects}

Both

Page 13: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 13 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#2

Area

How Verified

(by Demonstration or

by Design)

use this form unless there is a strong reason to do otherwise.

OS11

A CBV-Compliant document or CBV-Compatible document MAY use a private or industry-wide URN as specified below to populate the epcList, parentID, and childEPCs fields in EPCIS ObjectEvents, AggregationEvents, and TransacationEvents. However, both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form (Section 8.2.1) unless there is a strong reason to do otherwise. See Section 8.1.2. for general considerations regarding the use of Private or Industry-wide URI identifiers.

696 {8.2.2 Private URN Physical Objects}

Both

OS12

Both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form as specified in Section 8.3.1 unless there is a strong reason to do otherwise.

739 {8.3 Locations}

Both

OS13

A CBV-Compliant document or CBV-Compatible document MAY use an EPC Pure Identity URI as specified in Section 8.1.1 to populate the readPoint and businessLocation fields in all EPCIS event types. Both CBV-Compliant and CBV-Compatible documents SHOULD use this form unless there is a strong reason to do otherwise.

742 {8.3.1 EPC URI for Locations}

Both

OS14

Both CBV-Compliant and CBV-Compatible documents SHOULD NOT use EPC schemes other than SGLN EPCs (urn:epc:id:sgln:…) for location identifiers, unless there is a strong reason to do so.

747 {8.3.1 EPC URI for Locations}

Both

OS15

A CBV-Compliant document or CBV-Compatible document MAY use a private or industry-wide URN as specified below to populate the readPoint and businessLocation fields in all EPCIS event types. However, both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form

753 {8.3.2 Private URN for Locations}

Both

Page 14: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 14 of 28

Req. # Protocol

SubClause Requirements

Applies to

Spec Line

#2

Area

How Verified

(by Demonstration or

by Design)

(Section 8.1.2) unless there is a strong reason to do otherwise. See Section 8.1.2. for general considerations regarding the use of Private or Industry-wide URI identifiers.

OS16

A CBV-Compliant document or CBV-Compatible document MAY use an HTTP URL as specified below to populate the readPoint and businessLocation fields in all EPCIS event types. However, both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form (Section 8.1.3) unless there is a strong reason to do otherwise. See Section 8.1.3. for general considerations regarding the use of HTTP URL identifiers.

771 {8.3.3 HTTP URL for Locations}

Both

OS17

Both CBV-Compliant and CBV-Compatible documents SHOULD NOT use EPC schemes other than GDTI EPCs (urn:epc:id:gdti:…) or GSRN EPCs (urn:epc:id:gsrn:…) for business transaction identifiers, unless there is a strong reason to do so.

817 {8.4.1}

Both

OS18

A CBV-Compliant document or CBV-Compatible document MAY use an HTTP URL as specified below to populate the epcList, parentID, and childEPCs fields in EPCIS ObjectEvents, AggregationEvents, and TransacationEvents. However, both CBV-Compliant and CBV-Compatible documents SHOULD use the EPC URI form (Section 8.2.3) unless there is a strong reason to do otherwise. See Section 8.1.3 for general considerations regarding the use of HTTP URL identifiers.

718 {8.2.3 HTTP URL Physical Objects}

Both

OS19

64

65

Page 15: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 15 of 28

Optional MAY: 66

67

OM1 A CBV-Compatible document MAY use one of the three URI forms specified in this section, or MAY use any other URI that meets the general requirements specified in [EPCIS1.0], Section 6.4.

675 {8.2 Physical Objects}

Compatible

OM2 X A CBV-Compliant document or CBV-Compatible document MAY use a GLN-based identifier as specified below as a business transaction identifier in all EPCIS event types.

839 {8.4.1} Both

OM3 X A CBV-Compliant document or CBV-Compatible document MAY use a private or industry-wide URN as specified below as a business transaction identifier in all EPCIS event types.

851 {EPC URI for bti}

Both

OM4 X A CBV-Compliant document or CBV-Compatible document MAY use an HTTP URL as specified below as a business transaction identifier in all EPCIS event types.

866 {8.4.4} Both

OM5 X A CBV-Compatible document MAY use one of the three URI forms specified in this section, or MAY any other URI that meets the general requirements specified in [EPCIS1.0], Section 6.4.

736 {8.3 Locations}

Compatible

OM6 X A CBV-Compatible document MAY use one of the four URI forms specified in this section, or MAY use any other URI that meets the general requirements specified in [EPCIS1.0], Section 6.4.

795 {8.5 Business Transactions}

Compatible

68

69

Page 16: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 16 of 28

70

3 Test Case Requirements 71

A CBV Conformance Certification Program will test an Implementation Under Test 72

(IUT) according to predefined test case requirements that have been designed to isolate 73

and test specific features and functions of the CBV 1.0 Specification. While these test 74

case requirements are not exhaustive, they test all the mandatory features that are 75

required by the specification. 76

77

3.1 Test Case Requirement 1 – Schema Validation 78

TCR1: Conformance to the EPCIS 1.0.1 schema and other constraints

TPId: TCR-1: Conformance to the EPCIS 1.0.1 schema and other constraints

Requirement Purpose: Both CBV-Compliant and CBV-Compatible Document SHALL conform to the

schema and other constraints specified in [EPCIS1.0.1]

Requirements Tested: M1, M2

Pre-test conditions: None

Step Step description Expected results

1

Provide the document-to-test via file upload or

via HTTP POST.

Verify that in the submitted document:

XML is well formed.

XML is valid according to EPCIS schema.

Document is a capture-acceptable form

(EPCISDocument or EPCISQueryResponse

meeting requirements)

79

80

Page 17: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 17 of 28

81

3.2 Test Case Requirement 2 – Standard BizStep Validation 82

TCR2: Standard BizStep Validation

TPId: TCR-2: Standard BizStep Validation

Requirement Purpose: A CBV-Compliant Document SHALL include a bizStep field, and the value of the

bizStep field 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 7.1.2 Element Values and Definitions – Business Step

Requirements Tested: M3, M4, M5, M6

Pre-test conditions: Document passes TCR-1, and there are one or more events in the document.

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2 For each event found A BizStep is present

3

For each bizStep present BizStep passes all general URI tests

BizStep is NOT an EPC

BizStep is NOT an urn:epcglobal: URI other

than a biz step

List of CBV bizSteps: “accepting, arriving, commissioning, decommissioning, departing, destroying,

encoding, entering_exiting, holding, inspecting, killing, loading, other, packing, picking, receiving,

repackaging, reserving, retail_selling, shipping, staging_outbound, stocking, storing”

83

84

Page 18: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 18 of 28

85

3.3 Test Case Requirement 3 – Standard Disposition Validation 86

TCR3: Standard Disposition Validation

TPId: TCR-3: Standard Disposition Validation

Requirement Purpose: A CBV-Compliant Document MAY include a disposition field. If the disposition field

is present, the value of the disposition field SHALL be a URI consisting of the prefix urn:epcglobal:cbv:disp:

followed by the string specified in the first column of some row of the table in 7.2.2 Element Values and

Definitions – Dispositions.

Requirements Tested: M3, M4, M7

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

An event containing a disposition field is discovered

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

For each disposition present Disposition passes all general URI tests

Disposition is NOT an EPC

Disposition is NOT an urn:epcglobal: URI other

than a disposition.

List of CBV bizSteps: “active, container_closed, destroyed, encoded, inactive, in_progress, in_transit,

non_sellable_expired, non_sellable_damaged, non_sellable_no_pedigree_match, non_sellable_other,

non_sellable_recalled, reserved”

87

88

Page 19: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 19 of 28

89

3.4 Test Case Requirement 4 – Standard Biz Transaction Type 90

Validation 91

TCR4: Standard Biz Transaction Type Validation

TPId: TCR-4: Standard Biz Transaction Type Validation

Requirement Purpose: Each EPCIS event in a CBV-Compliant Document MAY include one or more

bizTransaction elements. If bizTransaction elements are present, each such element MAY include a type

attribute. If a given bizTransaction element includes a type attribute, the value of the type attribute SHALL be

a URI consisting of the prefix urn:epcglobal:cbv:btt: followed by the string specified in the first column of

some row of the table in 7.3.2 Element Values and Definitions – Business Transaction Types.

Requirements Tested: M3, M4, M8

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

An event containing a Biz Transaction field is discovered, and it contains a Biz Transaction Type.

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

For each event with a bizTransaction field that

contains bizTransactionType:

BizTransactionType passes all general URI tests

BizTransactionType is NOT an EPC

BizTransactionType is NOT an urn:epcglobal:

URI other than a BTI.

List of CBV bizSteps: “po, poc, bol, inv, rma, pedigree, de, idlv, odlv, whr, who, shipr, ship, shipo,

bookingorder, so, soc, pi, pd, pdc, svo, svoc, mto”

92

93

Page 20: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 20 of 28

94

3.5 Test Case Requirement 5 – User Vocabulary Elements 95

TCR5: User Vocabulary Elements

TPId: TCR-5: User Vocabulary Elements

Requirement Purpose: Test the instances of End User created vocabulary for compliance/compatibility with

CBV standards.

Requirements Tested: M9, M10, M11, M12, M13, M14, M15, M16, M17

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

One or more instance of user vocabulary elements is found of each of these types:

EPC URI

Private/Industry-Wide URN

HTTP URL

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

EPC URI is found Both CBV-Compliant and CBV-Compatible

documents SHALL use an EPC Pure Identity

URI.

Documents SHALL NOT use EPC Tag URIs

(urn:epc:tag:…) , EPC Pure Identity Pattern

URIs (urn:epc:idpat:…), or EPC Pattern URIs

(urn:epc:pat:…)

Documents MAY use EPC Raw URIs

(urn:epc:raw:…) as defined in [TDS1.4], Section

4.2.2, and [TDS1.5], Section 12, provided that

the raw value cannot be decoded as an EPC.

Documents SHALL NOT use an EPC Raw URI

representing EPC memory bank contents that

could be successfully decoded into an EPC Pure

Identity URI according to [TDS1.4] or [TDS1.5]

3

Private/Industry-Wide URN is found A Private or Industry-wide URI SHALL have the

following form:

urn:URNNamespace:**:qual:Remainder

Page 21: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 21 of 28

4

HTTP URL is found An HTTP URL SHALL have the following

form:

http://[Subdomain.]Domain/**/qual/Remainder

96

97

Page 22: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 22 of 28

98

3.6 Test Case Requirement 6 – User Defined Physical Objects 99

TCR6: User Defined Physical Objects

TPId: TCR-6: User Defined Physical Objects

Requirement Purpose: Test the instances of End User created EPCIS physical objects for

compliance/compatibility with CBV standards.

Requirements Tested: M9, M18, M19, M20, M21, M22, M32

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

One or more instance of user defined physical objects is found of each of these types:

EPC URI for Physical Objects

Private/Industry-Wide URN for Physical Objects

HTTP URL for Physical Objects

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

EPC URI for Physical Object is found Both CBV-Compliant and CBV-Compatible

documents SHALL NOT use an SGLN EPC

(urn:epc:id:sgln:…) as a physical object

identifier.

Documents SHALL NOT use any of the other

URI forms for EPCs defined in [TDS1.4] or

[TDS1.5]; see Section 8.1.1 for details.

3

Private/Industry-Wide URN for Physical

Object is found A Private or Industry-wide URI suitable for

populating the epcList, parentID, and childEPCs

fields of EPCIS events SHALL have the

following form:

urn:URNNamespace:**:obj:Objid

4

HTTP URL for Physical Object is found An HTTP URL suitable for populating the

epcList, parentID, and childEPCs fields of

EPCIS events SHALL have the following form:

http://[Subdomain.]Domain/**/obj/Objid

100

Page 23: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 23 of 28

3.7 Test Case Requirement 7 – User Defined Locations 101

TCR7: User Defined Locations

TPId: TCR-7: User Defined Locations

Requirement Purpose: Test the instances of End User created EPCIS locations for compliance/compatibility

with CBV standards.

Requirements Tested: M9, M23, M24, M25, M26, M32

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

One or more instance of user defined locations is found of each of these types:

EPC URI for Locations

Private/Industry-Wide URN for Locations

HTTP URL for Locations

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

EPC URI for Location is found A CBV-Compatible document MAY use one of

the three URI forms specified in this section, or

MAY any other URI that meets the general

requirements specified in [EPCIS1.0], Section

6.4..

Documents SHALL NOT use any of the other

URI forms for EPCs defined in [TDS1.4] or

[TDS1.5]; see Section 8.1.1 for details.

3

Private/Industry-Wide URN for Location is

found A Private or Industry-wide URI suitable for

populating the readPoint and businessLocation

fields in all EPCIS event types SHALL have the

following form:

urn:URNNamespace:**:loc:Locid

4

HTTP URL for Location is found An HTTP URL suitable for populating the

readPoint and businessLocation fields in all

EPCIS event types SHALL have the following

form: http://[Subdomain.]Domain/**/loc/Objid

102

Page 24: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 24 of 28

3.8 Test Case Requirement 8 – User Defined Business 103

Transaction Identifier 104

TCR8: User Defined Business Transaction Identifier

TPId: TCR-8: User Defined Business Transaction Identifier

Requirement Purpose: Test the instances of End User created EPCIS Business Transaction Identifiers for

compliance/compatibility with CBV standards.

Requirements Tested: M9, M27, M28, M29, M30, M31, M32

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

One or more instance of user defined business transaction identifier is found of each of these types:

EPC URI for Business Transaction Identifier

Private/Industry-Wide URN for Business Transaction Identifier

HTTP URL for Business Transaction Identifier

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

A CBV-Compliant document SHALL use one of the

four URI forms specified in Section 8.4 to populate the

business transaction identifier field (that is, the text

content of the bizTransaction element) of EPCIS events,

for every such field that is not null.

3

EPC URI for Business Transaction Identifier

is found A GLN-based URI suitable for use as a business

transaction identifier in all EPCIS event types

SHALL have the following form:

urn:epcglobal:cbv:bt:gln:transID

Check Line 841 Tables for format and length

4

Private/Industry-Wide URN for Business

Transaction Identifier is found A private or industry-wide URN suitable for use

as a business transaction identifier in all EPCIS

event types SHALL have the following form:

urn:URNNamespace:**:bt:transID

Check Line 865 Tables for format and length

Page 25: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 25 of 28

5

HTTP URL for Business Transaction

Identifier is found An HTTP URL suitable for use as a business

transaction identifier in all EPCIS event types

SHALL have the following form:

http://[Subdomain.]Domain/**/bt/transID

105

106

Page 26: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 26 of 28

107

3.9 Test Case Requirement 9 – Location Master Data Constraints 108

TCR9: Location Master Data Constraints

TPId: TCR-9: Location Master Data Constraints

Requirement Purpose: Test the instances of End User created EPCIS location master data for

compliance/compatibility with CBV standards.

Requirements Tested: M33, M35, M36, M37, M38

Pre-test conditions:

Document passes TCR-1.

There are one or more events in the document.

Location Master Data is used in those events, as required in the step descriptions below.

Step Step description Expected results

1 Provide the document-to-test via file upload or

via HTTP POST.

2

The Master Data Attribute is Site Location The value SHALL be a GLN or other site

identifier.

When the location identifier is an SGLN

EPC, the value of the corresponding Site

Location master data attribute SHALL be the

13-digit GLN implied by the company prefix

and location reference components of that

SGLN.

When the location identifier is some other

URI, the value of the corresponding Site

Location master data attribute SHALL be

any string of 128 characters or fewer that

identifies the site.

Site Level Identifier is required.

Sub-Site-Level Identifier is required

3

The Master Data Attribute is Sub-Site

Location Type The value SHALL be one of the numeric codes

specified in Table 9.3.2 Sub-Site Location Type

of the CBV Standard.

Site Level Identifier is omitted.

Sub-Site-Level Identifier is required.

Page 27: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 27 of 28

4

The Master Data Attribute is Sub-Site

Location Type Attributes The value SHALL be a list of zero or more

numeric codes specified in Table 9.3.3 Sub-Site

Location Type Attributes of the CBV Standard.

The value of the Sub-Site Location Type

Attributes master data attribute for a location

identifier SHALL be a string consisting of

zero or more of the codes in the following

table, separated by commas with no leading,

trailing, or internal whitespace characters.

If the value of the Sub-Site Location Type

Attributes master data attribute includes more

than one code, the codes SHALL appear in

ascending numerical sequence reading from

left-to-right.

Site Level Identifier is omitted.

Sub-Site-Level Identifier is optional.

5

The Master Data Attribute is Sub-Site Detail The value SHALL be an arbitrary string, whose

meaning must be agreed upon by trading

partners.

The value of the Sub-Site Detail master data

attribute for a location identifier, if present,

SHALL be any string of up to 128 characters

in length.

Site Level Identifier is omitted.

Sub-Site-Level Identifier is optional.

6

The Master Data Attribute is Location

Description The value SHALL be a string in natural

language. This field SHALL be limited to ASCII

characters and a length of 128.

Site Level Identifier is optional.

Sub-Site-Level Identifier is optional.

109

110

111

Page 28: CBV 1.0 Conformance Requirements

Copyright ©2009, 2010 EPCglobal®

, All Rights Reserved. Page 28 of 28

112

4 References 113

K. Traub, editor, Core Business Vocabulary Standard Version 1.0 (CBV), 114

http://www.epcglobalinc.org/standards/cbv, October 13, 2010 115

116

K. Traub, editor, “EPC Information Services (EPCIS) Version 1.0.1 Specification, 117

http://www.epcglobalinc.org/standards/epcis , September 21, 2007. 118

119