You are on page 1of 75

UN/CEFACT

Simple, Transparent and Effective Processes


For Global Commerce

BUSINESS REQUIREMENTS SPECIFICATION


(BRS)

Business Domain: Cross Industry – Supply Chain

Business Process: Catalogue Process

Document Identification: CEFACT/Forum/2006/TBG1

Title: Catalogue

UN/CEFACT International Trade and Business Processes Group: TBG1

Document location : http://www.uncefactforum.org/TBG/TBG1/tbg1.htm

Version: 1.00 review #2


Release: R.09B
Date of TBG approval: Date
Business Requirements Specification Catalogue

Document Summary
Document Item Current Value
Document Title Business Requirements Specification for Catalogue
Date Last Modified Date09
Current Document Issue Issue #2 of draft version
Status Draft for second review
Document Description Business requirement specification for product catalogue and complete
(one sentence summary) business process.

Contributors
Name Organization

Log of Changes
Issue No. Date of Change Changed By Summary of Change

Date 2008-11-10, Issue #2 UN/CEFACT Page 2 of 75


Business Requirements Specification Catalogue

TABLE OF CONTENTS
Preamble.....................................................................................5

References..................................................................................5

Objective ....................................................................................5
1.1. Scope...................................................................................................................................................6
1.2. Context Categories..............................................................................................................................7
1.3. Business Domain View ........................................................................................................................8
1.3.1. Catalogue Process within the BUY-SHIP-PAY Model.................................................................8
1.3.2. Catalogue Domain Use Case diagram........................................................................................8

Business Requirements View .......................................................9


1.4. Business Process Elaboration..............................................................................................................9
1.4.1. Provide Article/Product/Item/Partner Information via a Catalogue...............................................9
1.4.1.1. Business Process Use Case Description..........................................................................9
1.5. Business Entity Life Cycle..................................................................................................................13

Business Transactions-Use Case Diagrams..................................14


1.5.1. Request Subscription................................................................................................................14
1.5.2. Request Catalogue....................................................................................................................14
1.5.3. Provide Catalogue.....................................................................................................................14
1.5.4. Request Catalogue Update.......................................................................................................15
1.5.5. Provide Catalogue Update........................................................................................................15

Business Collaborations processes .............................................15


1.5.6. Provide Catalogue By Subscription Business Collaboration......................................................15
1.5.7. Provide Catalogue By Request Business Collaboration............................................................18

Business Transactions................................................................19
1.5.8. Request Catalogue Subscription business transaction..............................................................20
1.5.9. Request Catalogue business transaction..................................................................................22
1.5.10. Provide Catalogue business transaction.................................................................................24
1.5.11. Request Catalogue Update business transaction....................................................................26
1.5.12. Provide Catalogue Update business transaction.....................................................................28

Catalogue Information Model......................................................29

Business Documents..................................................................30
1.6. Subscription Request (Business Document)......................................................................................31
1.7. Catalogue Request (Business Document).........................................................................................34

Date 2008-11-10, Issue #2 UN/CEFACT Page 3 of 75


Business Requirements Specification Catalogue

1.8. Application Response (Business Document).....................................................................................37


1.8.1. Response to received catalogue line (Application Response)...................................................38
1.9. Catalogue (Business Document)........................................................................................................38
1.9.1.1. Catalogue Item (Catalogue)............................................................................................40
1.9.1.2. Tax Information (Catalogue Item)...................................................................................42
1.9.1.3. Tax Exemption (Tax Information)....................................................................................43
1.9.1.4. Trade Agreement (Catalogue Item)................................................................................43
1.9.1.5. Price information (Trade agreement)..............................................................................46
1.9.1.6. Price List Reference (Price information).........................................................................48
1.9.1.7. Price Comparison (Price Information) ............................................................................48
1.9.1.8. Trade Delivery (Catalogue Item).....................................................................................50
1.9.1.9. Product (Catalogue Item)...............................................................................................50
1.9.1.10. Product Identification (Product) ....................................................................................55
1.9.1.11. Marketing (Trade Agreement).......................................................................................55
1.9.1.12. Campaign (Marketing)..................................................................................................57
1.9.1.13. Warranty information (Trade Agreement).....................................................................57
1.9.1.14. Dimensions (Product)...................................................................................................57
1.9.1.15. Handling Instructions (Trade Delivery)..........................................................................58
1.9.1.16. Hazardous Information (Product)..................................................................................59
1.9.1.17. Hierarchy Information (Product) ..................................................................................61
1.9.1.18. Next lower product level information (Hierarchy Information).......................................61
1.9.1.19. Additional Product Relation (Catalogue Item)...............................................................61
1.9.1.20. Marketing Feature (Marketing)......................................................................................62
1.9.1.21. Marks and Labels (Package Information).....................................................................62
1.9.1.22. Logistic Unit Information (Product)................................................................................67
1.9.1.23. Package Information (Product).....................................................................................67
1.9.1.24. Packaging Information (Package information) .............................................................68
1.9.1.25. Packaging Material (Packaging information).................................................................69
1.9.1.26. Product Material (Product)............................................................................................69
1.9.1.27. Product Unit (Product)..................................................................................................70
1.9.1.28. Product Class (Product)................................................................................................70
1.9.1.29. Property (Packaging Material, Product, Product Material and Product Class)..............71
1.9.1.30. Product Specification Information Reference (Product)................................................73
1.9.1.31. Trade Item Delivery Lead Time (Trade Agreement).....................................................73
1.9.1.32. Signature (All documents).............................................................................................74

Business Rules...........................................................................74

Use case examples.....................................................................74

Definition of Terms....................................................................75

Date 2008-11-10, Issue #2 UN/CEFACT Page 4 of 75


Business Requirements Specification Catalogue

Preamble
The current practice of exchanging business documents by means of telecommunications – usually
defined as e-Business – presents a major opportunity to improve the competitiveness of companies,
especially for Small and Medium Enterprises (SME).
The catalogue is an important document exchanged between trading partners, it marks the start of the
trading cycle.
Started as an initiative by CEN/ISSS Workshop eBES, the European Expert Group 1 (EEG1) – Supply
Chain & e-Procurement – developed the Cross Industry Catalogue in 2005/2006. The Cross Industry
Catalogue has been compiled by a working group with contributions from BME (German Association
Materials Management, Purchasing and Logistics), BLI at the University of Duisburg-Essen,
Fernuniversität Hagen, PIDX, OASIS/UBL, CRITT Informatique, SupplyChange, Healthlogistics,
Eurofer, CEN/ISSS WS E-Catalogue. Paradigma Unternehmensberatung Gmbh, EPDC, ISO TC184
SC4 and VWR, GS1, the Danish government and Swedish Local authorities and regions.
The document describe globally consistent catalogue information exchange processes for worldwide
supply chains and e-Procurement of commodities, using the UN/CEFACT Modelling Methodology
(UMM) approach and Unified Modelling Language to describe the business processes and business
documents involved.
The structure of this document is based on the structure of the UN/CEFACT Business Requirements
Specification (BRS) document reference CEFACT/ICG/005.

References
UN/CEFACT Modelling Methodology (CEFACT/TMG/N090R10, November 2001)
UN/CEFACT –ebXML Core Components Technical Specification version 2.01 – ISO 15000-5
UN/CEFACT Business Requirements Specification version 1.5 (CEFACT/ICG/005)
Unified Modelling Language (UML version 1.4)
Actors, Roles, Partners & Parties UN/CEFACT TBG14 BPA/N061 - 10th Aug 2006

Objective
The objective of this specification is to describe the business processes, the business documents and
the information entities for the exchange of catalogue information, including price information, used by
industries for the supply chain.
The business process is the detailed description of the way trading partners intend to play their
respective roles, establish business relations and share responsibilities to interact efficiently with the
support of their respective information systems.
The collaborative business processes involved in the catalogue process are made up by five business
transactions.
Each business transaction is realised by an exchange of business information (documents and
messages). The sequence in which these transactions are used, represent particular scenarios and
are presented as activity diagrams in this document.
The information exchanged in the business documents/messages are presented in lists of business
entities and their attributes.

Date 2008-11-10, Issue #2 UN/CEFACT Page 5 of 75


Business Requirements Specification Catalogue

1.1. Scope
This section describes the extent and limits of the business processes within the supply chain being
described in this document. Each industry may specify, based on the BRS of the cross industry
catalogue processes, its industry specific use of the catalogue message and the business processes.
It also allows for industry specific functionality on details to describe a specific product.
Name/Value pairs in the catalogue documents allows the Catalogue Provider to add attributes to
further specify their products in the existing structure. If further elaboration is needed an industry
specific ontology can be made. Industry specific ontology is outside the scope of this BRS.
The catalogue processes are used to offer goods or services by the Supplier to potential Customers
and give basic information needed for ordering those goods or services. A catalogue will contain
information on the products being offered and may contain price information, terms of trade and other
commercial information.
The processes cover:
Exchange of multi language catalogues
Exchange of catalogue being a full catalogue or part of a catalogue in relation to updates
Exchange of multi Supplier catalogues or parts of multi Suppliers catalogues in relation to updates
Customer specific catalogue items and prices, including contract prices
This document describes the processes involved in the exchange of catalogue data and how to
structure the information in electronic catalogues, so they can be sent to customers and potential
customers, in whole or part, and be the basis for the ordering of the goods or services defined in those
catalogues. Customers may ask for catalogue data ad hoc, or they may subscribe to the catalogue
process and receive all or parts of the catalogue data.

Date 2008-11-10, Issue #2 UN/CEFACT Page 6 of 75


Business Requirements Specification Catalogue

1.2. Context Categories


The following table lists the context categories according to the Core Components Technical
Specification and their values for the catalogue processes.
The Business Process Roles in the table represent the Business Partner Types (Party Types) of the
senders and receivers of the information flows that make up the Provide Catalogue process. The
Supporting Roles represent those Business Partner Types involved in related business processes that
are referred to in the information exchanged within the Provide Catalogue process.(see ref. 5)

Categories Description and Values


Business Process Catalogue Process
Product Classification All
Industry Classification All
Geopolitical Global
Official Constraint None
Business Process Role Catalogue Provider, Catalogue Receiver
Supporting Role Buyer, Seller, Manufacturer ,BrandOwner, Carrier, Warranty Provider etc1
System Capabilities No limitations

1
See Actors, Roles, Partners & Parties UN/CEFACT TBG14 BPA/N061 - 10th Aug 2006

Date 2008-11-10, Issue #2 UN/CEFACT Page 7 of 75


Business Requirements Specification Catalogue

1.3. Business Domain View

1.3.1. Catalogue Process within the BUY-SHIP-PAY Model


The Catalogue Business Process is part of the supply chain process. A catalogue may be
thought of as equivalent to a quotation or as part of a contract reflecting product information
and agreed terms of business. It is positioned within the BUY-SHIP-PAY model as part of the
Establish Business Agreement use case.
uc Catalogue

«ProcessArea»
Catal ogue

+ Catalogue
+ Catalogue
+ Catalogue

(from EstablishBusinessAgreement)

:ldentifyPotential Trading :Establ ishBusi ness :Ship :Pay


:Order
Partner Agreement

Figure 1. Positioning of the Catalogue process within the BUY-SHIP-PAY model.

1.3.2. Catalogue Domain Use Case diagram


The Business partner types involved in the catalogue process includes the Customer, Supplier or
Intermediary. They play the roles of Catalogue Provider and Catalogue Receiver.

Date 2008-11-10, Issue #2 UN/CEFACT Page 8 of 75


Business Requirements Specification Catalogue

uc Catalogue

SubscibeToCatalogue

«participates» RequestCatalogue
«participates»

«participates» «participates»

«participates» Prov ideCatalogue «participates»


CatalogueProv ider CatalogueReceiv er

«participates» «participates»

«participates» «participates»
Request
CatalogueUpdate

Prov ide
CatalogueUpdate

Figure 2. Catalogue-Business Domain Use Case Diagram


The use cases shown in figure 2 are elaborated in section 4, below.

Business Requirements View


1.4. Business Process Elaboration
This section elaborates the business use cases that make up the catalogue process.

1.4.1. Provide Article/Product/Item/Partner Information via a Catalogue

1.4.1.1. Business Process Use Case Description

Business Provide Article/Product/Item/Partner Information via a Catalogue


process name
Identifier BUY-SHIP-PAY/ Procurement&Sales/ EstablishBusinessAgreement/
Catalogue/ Catalogue Subscription
Business Catalogue Provider, Catalogue Receiver
Partner Types

Date 2008-11-10, Issue #2 UN/CEFACT Page 9 of 75


Business Requirements Specification Catalogue

Pre-conditions PrC1 - Catalogue Receiver has a need for a catalogue.


(PrC) PrC2 - Parties may have an established business agreement.
PrC3 - The Catalogue Receiver and Catalogue Provider may have established a
Catalogue Subscription including agreement concerning the updating of the catalogue
Or
PrC4 - the Catalogue Provider provides the catalogue to the Catalogue Receiver
according to the Request for Catalogue provided by the Catalogue Receiver.
Or
PrC5 - the Catalogue Provider provides the catalogue to the Catalogue Receiver by using
both Catalogue Subscription and Request for Catalogue.
Description The Catalogue Receiver sends a request for a catalogue subscription to the Catalogue
Provider.
The process results in an accepted catalogue subscription request or in the rejection of
the catalogue subscription request.
The Catalogue Receiver requests a catalogue from a Catalogue Provider using
Catalogue Request or the Catalogue Provider issues a Catalogue to the Catalogue
Receiver according to the agreed terms in the Catalogue Subscription.
The Catalogue Provider may reject the request for a catalogue or provide a catalogue
according to the request.
If the Catalogue Request is rejected by the Catalogue Provider the Catalogue Receiver
may request a Catalogue again by using Catalogue Request.
The Catalogue Provider may provide a catalogue according to agreed terms in the
Catalogue Subscription.
On receipt of the catalogue the Catalogue Receiver notifies the Catalogue Provider of the
acceptance or rejection of the catalogue.
If a Catalogue provided according to a catalogue subscription is rejected by the
Catalogue Receiver the Catalogue Provider can provide an altered catalogue after
considering the cause for rejection and according to the agreed terms in the Catalogue
Subscription.
The Catalogue Provider provides the Catalogue update according to the agreed terms in
the Catalogue Subscription or the Catalogue Provider provides the Catalogue update
according to the requirements in the Catalogue Request.
The Catalogue Update may be a full catalogue containing all items including changed and
unchanged item information. This replacement catalogue replaces all the prior catalogue
information.
The catalogue update may contain only information about changed item information. This
changed information replaces only the catalogue information for the identified catalogue
item in previous accepted catalogue.
The Catalogue Receiver notifies the Catalogue Provider of the acceptance or the
rejection of the catalogue update received.
The Catalogue Receiver may request a Catalogue update again by using Catalogue
Request.
If a Catalogue Update provided according to a catalogue subscription is rejected by the
Catalogue Receiver the Catalogue Provider can provide an altered catalogue update after
considering the cause for rejection and according to the agreed terms in the Catalogue
Subscription.
After acceptance of the catalogue, the Catalogue Receiver can use the data provided for
further business processes.
When a Catalogue Update is rejected the Catalogue Receiver must consider items may
have been expired, replaced or price changed even though the Catalogue Update has
been rejected by the Catalogue Receiver.

Date 2008-11-10, Issue #2 UN/CEFACT Page 10 of 75


Business Requirements Specification Catalogue

Post-conditions PoC1 - Catalogue Subscription Request is rejected:


(PoC) After the rejection of the catalogue subscription request the same situation exists as
defined under the pre-condition PrC1.
PoC2 - Catalogue request is rejected:
After the rejection of the request for catalogue the same situation exists as defined under
the pre-condition PrC1.
PoC3 –Provided Catalogue is rejected and the Catalogue Provider is notified regarding
the reason
After the rejection of the catalogue the same situation exists as defined under the pre-
condition PrC1.
PoC4 – Provided Catalogue Update is accepted.
Provided Catalogue Update is accepted by the Catalogue Receiver
PoC5 – Provided Catalogue Update is rejected.
Catalogue Update is Rejected by the Catalogue Receiver
After the rejection of the Catalogue Update the same situation exists as defined under the
pre-condition PrC3, or PrC4 or PrC5.
After rejection of a received catalogue update, the Catalogue Receiver may request a
Catalogue again by using Catalogue Request or after considering the cause for rejection
and according to the agreed terms in the Catalogue Subscription the Catalogue Provider
provide an altered catalogue update.
Scenario The catalogue processes are used to offer goods or services by the Supplier to potential
Customers and give basic information needed for ordering those goods or services. A
catalogue will contain information on the products being offered and may contain price
information, terms of trade and other commercial information.
The processes cover:
Exchange of multi language catalogues
Exchange of catalogue being a full catalogue or part of a catalogue in relation to
updates
Exchange of multi Supplier catalogues or parts of multi Suppliers catalogues in
relation to updates
Customer specific items and prices, including contract prices

Table 4-1 Business Process Use Case Description

Date 2008-11-10, Issue #2 UN/CEFACT Page 11 of 75


Business Requirements Specification Catalogue

act Catalogue

CatalogueProv ider CatalogueReceiv er

ActivityInitial [subscribe]

«BusinessProcessActivit... «SharedBusinessEntityState» «BusinessProcessActivity»


Receiv e&ProcessRequest :Catalogue RequestCatalogueSubscription
[CatalogueSubscriptionRequested]

«BusinessProcessActivity» «SharedBusinessEntityState» «BusinessProcessActivity»


NotifyRej ectionOfSubscriptionRequest :Catalogue Receiv eRej ectionNotification
[reject]
[CatalogueSubscriptionRejected] [request]
[accept]

«BusinessProcessActivity» «SharedBusinessEntityState» «BusinessProcessActivity»


NotifyAcceptanceOfSubscriptionRequest :Catalogue Receiv eAcceptanceNotification
[CatalogueSubscriptionAccepted]

[provide [request]
catalogue without
request] «BusinessProcessActi... «SharedBusiness...
«BusinessProcessA...
Receiv e&AssessRequest :Catalogue
RequestCatalogue
[CatalogueRequested]

«BusinessProcessA... «SharedBusinessEntity... «BusinessProcessA...


NotifyRej ection :Catalogue Receiv eRej ection
[reject] [CatalogueRequestRejected]

[accept] «BusinessProcessA... «SharedBusinessEntity... «BusinessProcessActivity»


NotifyAcceptance :Catalogue Receiv eAcceptanceNotification
[CatalogueRequestRejected]

«BusinessProcessActiv... «SharedBusines... «BusinessProcessActivi...


IssueCatalog :Catalogue Receiv e&CheckCatalogue
[CatalogueProvided]

[if subscription
exists]

[reject]
«SharedBusines... «BusinessProcessActi...
«BusinessProcessActivity»
:Catalogue NotifyRej ection
Receiv eRej ectionNotification
[CatalogueRejected]
[accept]

«BusinessProcessActivity» «SharedBusines...
«BusinessProcessActivity»
Receiv eAcceptanceNotification :Catalogue
NotifyAcceptance
[CatalogueAccepted]

[if update
[if subscription
required]
and update
available] «SharedBusinessEntitySt... «BusinessProcessActiv...
«BusinessProcessActivity»
:Catalogue RequestCatalogueUpdate
CheckCatalogueUpdateRequest
[CatalogueUpdateRequested]
[accept]

«BusinessProcessActivi... «SharedBusinessEntit... «BusinessProcessActi ...


SendCatalogueUpdate :Catalogue Receiv e&Check
CatalogueUpdate
[CatalogueUpdateProvided]
[reject]
[reject]

«BusinessProcessA... «SharedBusinessEntity... «BusinessProcessActi...


Receiv eRej ection :Catalogue Rej ectCatalogueUpdate
[CatalogueUpdateRejected] [accept]

«BusinessProcessA... «SharedBusinessEntity...
Receiv eAcceptance :Catalogue «BusinessProcessActivity»
[CatalogueUpdateAccepted] AcceptCatalogueUpdate

End

Figure 3 Business Process Activity Diagram of Provide Article/Product/Item/Partner Information via a


Catalogue

Date 2008-11-10, Issue #2 UN/CEFACT Page 12 of 75


Business Requirements Specification Catalogue

1.5. Business Entity Life Cycle


The Business Entity Life Cycle shows the states that the Catalogue Entity may reach as the Catalogue
business process is executed. Each change of state results from the exchange of information between
the business partners using the appropriate business transactions. The Catalogue Process requires
four re-useable business transactions to achieve this. See section 5 and 7 for the transaction details.
stm Catalogue

Initial
Start here if
Catalogue
is" provided
by request"
«BusinessEntityState»
CatalogueSubscriptionRequested

«BusinessEntityState»
CatalogSubscriptionRej ected
«BusinessEntityState» «BusinessEntitySta...
CatalogueSubscriptionAccepted CatalogueRequested

«BusinessEntityState»
CatalogueRequestAccepted

«BusinessEntitySta...
CatalogueProv ided

«BusinessEntitySta...
CatalogueRej ected
«BusinessEntityState»
CatalogRequestRej ected
«BusinessEntitySta...
CatalogueAccepted
«BusinessEntityState»
CatalogueUpdateRequested

«BusinessEntityState»
CatalogueUpdateProv ided

«BusinessEntityState»
CatalogueUpdateAccepted

«BusinessEntityState»
CatalogueUpdateRequestRej ected

«BusinessEntityState»
CatalogueUpdateRej ected

Final

Figure 4 Business Entity States for Catalogue Process

Date 2008-11-10, Issue #2 UN/CEFACT Page 13 of 75


Business Requirements Specification Catalogue

Business Transactions-Use Case Diagrams


The five business transactions that realize the catalogue process are RequestSubscription,
RequestCatalogue, ProvideCatalogue, RequestCatalogueUpdate and ProvideCatalogueUpdate.
These transactions are detailed in the sections below.

1.5.1. Request Subscription


uc RequestSubscription

«BusinessTransactionUseCase»
«participates» RequestSubscrption «participates»

SubscriptionRequester SubscriptionResponder

Figure 5 RequestSubscription Use Case diagram

1.5.2. Request Catalogue


uc RequestCatalogue

«BusinessTransactionUseCase»
«participates» Request Catalogue «participates»
CatalogueRequester
CatalogueResponder

Figure 6 RequestCatalogue Use Case diagram

1.5.3. Provide Catalogue


uc Prov ideCatalog...

«BusinessTransactionUseCase»
«participates» Prov ide Catalogue «participates»

Prov ider Receiver

Figure 7 ProvideCatalogue Use Case diagram

Date 2008-11-10, Issue #2 UN/CEFACT Page 14 of 75


Business Requirements Specification Catalogue

1.5.4. Request Catalogue Update


uc RequestCatalogueUpdate

«BusinessTransactionUseCase»
Request
«participates» «participates»
CatalogueUpdate

CatalogueUpdateRequester CatalogueUpdateRequestResponder

Figure 8 RequestCatalogueUpdate Use Case diagram

1.5.5. Provide Catalogue Update


uc Prov ideCatalogueUpd...

«BusinessTransactionUseCase»
Prov ide
«participates» CatalogueUpdate «participates»

UpdateProv ider UpdateReceiv er

Figure 9 ProvideCatalogueUpdate Use Case diagram

Business Collaborations processes


The two business collaborations in the Catalogue process are implemented using five business
transactions illustrated above. The authorized roles of the sender and receiver of the business
transactions in the collaborations are related to the Catalogue Provider and Catalogue Receiver. The
order in which the transactions occur is shown in the corresponding Activity diagram.

1.5.6. Provide Catalogue By Subscription Business Collaboration


This collaboration uses two of the transactions-RequestSubscription and NotifyResponse.
The Subscription Requester and the ResponseReceiver roles in the transactions are taken by the
Catalogue Receiver. The SubscriptionResponder and ResponseProvider roles are taken by the
Catalogue Provider. Sub

Date 2008-11-10, Issue #2 UN/CEFACT Page 15 of 75


Business Requirements Specification Catalogue

uc Prov ideCatalogueBySubscripti...

Catalogue
«participates» «parti cipates»

CatalogueReceiv er CatalogueProv ider

(from Catalogue) (from Catalogue)


include
«mapsTo»
«mapsTo»

«BusinessTransactionUseCase»
«participates» RequestSubscrption «parti cipates»
«mapsTo»

SubscriptionResponder
(from RequestSubscription)
SubscriptionRequester
(from RequestSubscription)
(from RequestSubscription) include
«mapsTo»

«BusinessTransactionUseCase»
«participates» Request Catalogue «participates»

CatalogueResponder
CatalogueRequester (from RequestCatalogue)
(from RequestCatalogue)
«mapsT o»
(from RequestCatalogue)
«mapsTo»
«mapsT o»
include

«mapsTo»
«BusinessTransactionUseCase»
«participates» Prov ide Catalogue «participates»

Receiv er Prov ider


(from ProvideCatalogue)
(from ProvideCatalogue) i nclude (from ProvideCatalogue)
«mapsTo»

«BusinessTransactionUseCase»
Request
«partici pates» CatalogueUpdate «parti cipates»

CatalogueUpdateRequester CatalogueUpdateRequestResponder
(from RequestCatalogueUpdate)
(from RequestCatalogueUpdate) (from RequestCatalogueUpdate)
incl ude «mapsTo»

«BusinessTransactionUseCase»
«participates» Prov ide
CatalogueUpdate «participates»

UpdateReceiv er UpdateProv ider


(from ProvideCatalogueUpdate)
(from ProvideCatalogueUpdate) (from Provi deCatalogueUpdate)

Figure 11. SubscribeToCatalogue BusinessCollaboration


The order in which the different transactions take place is shown in figure 12 below, the activity diagram
of SubscribeToCatalogue business collaboration

Date 2008-11-10, Issue #2 UN/CEFACT Page 16 of 75


Business Requirements Specification Catalogue

act Prov ideCatalogBySubscripti...

ActivityInitial

«BusinessTransaction...
RequestSubscription

«BusinessTransactionActiv ity»
RequestCatalogue

«BusinessTransactio...
Prov ideCatalogue

«BusinessTransaction...
RequestCatalogueUpdate

«BusinessTransactio...
Prov ideCatalogueUpdate

ActivityFinal

Figure 12 ProvideCatalogueBySubscription Business Collaboration activity diagram

Thus the ProvideCatalogueBySubscription BusinessCollaboration uses five transactions.


The RequestSubscription transaction may be followed by the RequestCatalogue transaction before
the ProvideCatalogue transaction.

Date 2008-11-10, Issue #2 UN/CEFACT Page 17 of 75


Business Requirements Specification Catalogue

The ProvideCatalogue transaction may or may not be followed by a RequestCatalogueUpdate before


a ProvideCatalogueUpdate transaction follows.

1.5.7. Provide Catalogue By Request Business Collaboration


This collaboration uses two of the transactions-RequestCatalogue, ProvideCatalogue.
The Catalogue Requester and the Catalogue Receiver roles in the transactions are taken by the
Catalog Receiver. The Catalogue Responder and Catalogue Provider roles are taken by the
Catalogue Provider. Application Response message must be used in both the CatalogueRequest and
the ProvideCatalogue.
uc Prov ideCatalogueByRequ...

Catalogue
«participates» «participates»

CatalogueReceiv er CatalogueProv ider


(from ProvideCatalogueBySubscription)
(from Catalogue) (from Catalogue)
include
«mapsTo» «mapsTo»

«BusinessTransactionUseCase»
«participates» Request Catalogue «participates»

«mapsTo»
CatalogueRequester CatalogueResponder
(from RequestCatalogue) (from RequestCatalogue)
(from RequestCatalogue)

include
«mapsTo»

«BusinessTransactionUseCase»
«participates» Prov ide Catalogue «participates»

Receiv er Prov ider


(from ProvideCatalogue) (from ProvideCatalogue) (from ProvideCatalogue)

Figure 13 ProvideCatalogueByRequest BusinessCollaboration

The order in which the transactions take place is shown in Figure 14 below, the activity diagram of
ProvideCatalogueByRequest business collaboration.

Date 2008-11-10, Issue #2 UN/CEFACT Page 18 of 75


Business Requirements Specification Catalogue

act Prov ideCatalogueByRequ...

ActivityInitial

«BusinessTransaction...
RequestCatalog

«BusinessTransaction...
Prov ideCatalogue

ActivityFinal

Figure 14. Activity diagram of ProvideCatalogueByRequest Business Collaboration

The ProvideCatalogueByRequest Collaboration uses the transactions in the order shown in Figure 14.

Business Transactions
The transactions used in the Catalogue Process are described in the worksheets below and the
transaction pattern illustrated in the activity diagrams. These show the authorized roles of the sender
and responder together with the activities that take place and the name of the information envelope
that carries the information (message) exchanged.

Date 2008-11-10, Issue #2 UN/CEFACT Page 19 of 75


Business Requirements Specification Catalogue

1.5.8. Request Catalogue Subscription business transaction

Business RequestSubscription
Transaction name
Description The Catalogue Receiver sends a request for a catalogue subscription to the Catalogue
Provider. The Catalogue Provider receives the request and must respond using an
application response.
Transaction SubscriptionResponse
Pattern
Requester’s side
Requesting Role SubscriptionRequester
Requesting RequestSubscription
Business Activity
Name
Business SubscriptionRequest
Information
Envelope
Responder’s Side
Responding Role SubscriptionResponder
Responding ReceiveSubscriptionRequest
Business Activity
Name
Business ApplicationResponse
Information
Envelope

Table 5-1 Business Transaction Worksheet for RequestSubscription

Date 2008-11-10, Issue #2 UN/CEFACT Page 20 of 75


Business Requirements Specification Catalogue

act RequestSubscription
«BusinessTransactionSw imlane» «BusinessTransactionSw imlane»
SubscriptionRequester SubscriptionResponder

Initial
State

«RequestingBusinessActiv ity»
«RespondingInformationEn...
RequestSubscription
:ApplicationResponse

[Success]

[Failure]
FinalStateName.Success

FinalStateName.Failure

«RequestingInformationEnvelop...
«RespondingBusinessActiv ity»
:SubscriptionRequest
Receiv eSubcriptionRequest

Figure 17 Activity diagram for RequestSubscription Transaction

Date 2008-11-10, Issue #2 UN/CEFACT Page 21 of 75


Business Requirements Specification Catalogue

1.5.9. Request Catalogue business transaction

Business Transaction RequestCatalogue


name
Description The Catalogue Receiver requests a catalogue from a Catalogue Responder. The
Catalogue Provider receives the request and must respond using an application
response.
Transaction Pattern Request Response
Requester’s Side
Requesting Role CatalogueRequester
Requesting Business RequestCatalogue
Activity Name
Business Information CatalogueRequest
Envelope
Responder’s Side
Responding Role CatalogueResponder
Responding Business ReceiveCatalogueRequest
Activity Name
Business Information ApplicationResponse
Envelope

Table 5-2 Business Transaction worksheet-RequestCatalogue

Date 2008-11-10, Issue #2 UN/CEFACT Page 22 of 75


Business Requirements Specification Catalogue

act RequestCatalogue
«BusinessTransactionSw imlane» «BusinessTransactionSw imlane»
CatalogueRequester :CatalogueResponder

Initial
State

«RequestingBusinessActiv ity» «RespondingInformationEnvelope»


RequestCatalogue :ApplicationResponse

[Success]

[Failure]
FinalStateName.Success

FinalStateName.Failure

«RespondingBusinessActiv ity»
«RequestingInformationEnvelo...
Receiv eCatalogueRequest
CatalogueRequest

Figure 18. Activity diagram for RequestCatalogue transaction

Date 2008-11-10, Issue #2 UN/CEFACT Page 23 of 75


Business Requirements Specification Catalogue

1.5.10. Provide Catalogue business transaction

Business Provide Catalogue


Transaction name
Description The Provider provides Catalogue to a Receiver. The Receiver receives the Catalogue.
Transaction Pattern CatalogueReceiptResponse
Requester’s side
Requesting Role Provider
Requesting IssueCatalogue
Business Activity
Name
Business Catalogue
Information
Envelope
Responder’s Side
Responding Role Receiver
Responding ReceiveCatalogue
Business Activity
Name
Business ApplicationResponse
Information
Envelope

Table 5-3 Business Transaction worksheet-ProvideCatalogue

Date 2008-11-10, Issue #2 UN/CEFACT Page 24 of 75


Business Requirements Specification Catalogue

act Prov ideCatalog


«BusinessTransactionSw imlane» «BusinessTransactionSw imlane»
Prov ider Receiv er

Initial
State

«RequestingBusinessActiv ity» «RespondingInformationEnve...


IssueCatalogue :ApplicationResponse

[Failure]
[Success]

FinalStateName.Failure

FinalStateName.Success

«RequestingInformationEnvelope»
«RespondingBusinessActiv ity»
:Catalogue Receiv eCatalogue

Figure19. ProvideCatalogue BusinessTransaction

Date 2008-11-10, Issue #2 UN/CEFACT Page 25 of 75


Business Requirements Specification Catalogue

1.5.11. Request Catalogue Update business transaction

Business Transaction RequestCatalogueUpdate


name
Description The Catalogue Requester requests catalogue from a Catalogue Responder. The
data may be an original catalogue or an update of a whole catalogue or updates
for a part of a catalogue.
Transaction Pattern CatalogueUpdateRequestResponse
Requester’s Side
Requesting Role CatalogueUpdateRequester
Requesting Business RequestCatalogueUpdate
Activity Name
Business Information CatalogueUpdateRequest
Envelope
Responder’s Side
Responding Role CatalogueUpdateRequestResponder
Responding Business ReceiveCatalogueUpdateRequest
Activity Name
Business Information ApplicationResponse
Envelope

Table 5-2 Business Transaction worksheet-RequestCatalogueUpdate

Date 2008-11-10, Issue #2 UN/CEFACT Page 26 of 75


Business Requirements Specification Catalogue

act RequestCatalogueUpdate
«BusinessTransactionSw imlane» «BusinessTransactionSw imlane»
CatalogueUpdateRequester :CatalogueUpdateRequestResponder

Initial
State

«RequestingBusinessActiv ity»
«RespondingInformationEnvelope»
RequestCatalogueUpdate
:ApplicationResponse

[Success]

[Failure]
FinalStateName.Success

FinalStateName.Failure

«RequestingInformationEnvelo... «RespondingBusinessActiv ity»


:CatalogueUpdateRequest Receiv eCatalogueUpdateRequest

Figure 18. Activity diagram for RequestCatalogueUpdate transaction

Date 2008-11-10, Issue #2 UN/CEFACT Page 27 of 75


Business Requirements Specification Catalogue

1.5.12. Provide Catalogue Update business transaction

Business Provide Catalogue Update


Transaction name
Description The Provider provides Catalogue Update to a Receiver. The Receiver receives the
Catalogue Update.
Transaction Pattern CatalogueReceiptResponse
Requester’s side
Requesting Role Update Provider
Requesting IssueCatalogueUpdate
Business Activity
Name
Business Catalogue
Information
Envelope
Responder’s Side
Responding Role Update Receiver
Responding ReceiveCatalogueUpdate
Business Activity
Name
Business ApplicationResponse
Information
Envelope

Table 5-3 Business Transaction worksheet-ProvideCatalogue

Date 2008-11-10, Issue #2 UN/CEFACT Page 28 of 75


Business Requirements Specification Catalogue

act Prov ideCatalogUpdate


«BusinessTransactionSw imlane» «BusinessTransactionSw imlane»
UpdateProv ider UpdateReceiv er

Initial
State

«RequestingBusinessActiv ity» «RespondingInformationEnve...


IssueCatalogueUpdate :CatalogueReceiptResponse

[Failure]
[Success]

FinalStateName.Failure

FinalStateName.Success

«RequestingInformationEnvelope»
«RespondingBusinessActiv ity»
:Catalogue Receiv eCatalogueUpdate

Figure19. ProvideCatalogueUpdate BusinessTransaction

Catalogue Information Model


The Business Entities involved in a Catalogue and the relations between them are shown in the
Catalogue Entity Model, figure 20 below.
A catalogue consists of Catalogue Items and these contain details of products, trade agreement and
trade delivery. The business attributes of these entities form the basis for the information exchanged in
the Catalogue transaction set.

Date 2008-11-10, Issue #2 UN/CEFACT Page 29 of 75


Business Requirements Specification Catalogue

req Catalogue Entity Model

Catalogue Signature Next Lower Product


Hi erarchy
0..* Level Informati on
Information
1..*

0..1
Hazardous Logistic unit Product Specifi cation
Information i nformation Information Reference
0..*
Dimensions 0..1 0..1
T ax Exemption Product Unit
Reason 0..*
0..1
0..1
Product Class

Tax Information Product Product 0..*


Identifi cation 1

0..* 1 Product Material


0..*

1..*

Catalogue Item Trade Delivery


0..1 0..* 0..* 0..*
0..1
Package Property
Information

Trade 0..1 0..*

0..* Agreement Handling 0..1


0..1
Instructions
Additional Packaging
Product Relation Information
0..* 0..*
0..*
T rade Item Delivery Marks and
Price Information Labels 0..*
Lead Time
Packaging
0..1 Material
Marketing
0..1 Campaign
0..*
Price
Comparison

0..1 0..* 0..*

Price List Warranty Marketing


Reference Information Feature

Figure 20. Catalogue Entity Model

Business Documents
The information exchanged in the information envelopes described in the four business transactions
represent the Subscription Request, Catalogue Request, Application Response and Catalogue. The
detailed content for these are described below.
General remarks:
• When texts have a cardinality of ..* this is meant to support communication of the same text in
multiple languages.

Date 2008-11-10, Issue #2 UN/CEFACT Page 30 of 75


Business Requirements Specification Catalogue

1.6. Subscription Request (Business Document)


UID Crd Short Name2 Business Requirement Rationale / Example / Mapping
Notes
SRQ
SRQ 1..1 Document Generic document.
0001 Information
SRQ 1..1 Subscription The identifier of the subscription
0002 Request Identifier request message
SRQ 1 Subscription The date/time when the
0003 Request Issue date Catalogue subscription request
time message is issued.
SRQ 0..* Subscription To provide an general overall Use case: Can be used for the
0004 Request description for the Subscription subscribtion requester of a catalogue
Description text Request for catalogue to describe content of subscribed
catalogue.
This description is not an alternative of
using Product groups or Product
classification.
UBL e.g. “Computer accessories for
laptops.”

SRQ 1..1 Catalogue The requester of the catalogue The requester of a catalogue
0005 Subscription subscription subscription and the receiver of
Requester catalogue
SRQ 1..1 Catalogue The receiver of the catalogue The receiver of a catalogue
0006 Subscription subscription request subscription request and the provider
Receiver of a catalogue
SRQ 0..1 Procurement Party The party at the customer side UBL
0007 responsible for negotiating the
contract and the contents of the
catalogue.
SRQ 0..n Supplier party Supplier (s) whose catalogue
0008 (s) is requested to be
subscribed to
SRQ 0..n Contract Reference Reference to the Contract(s)
0009 the catalogue subscription
request is subject of.
SRQ 0..n Document Reference to other document UBL
0010 Reference (s) applicable for the catalogue
subscription
SRQ 0..n Signature To facilitate digital signing of the UBL
0011 subscription request
SRQ 0..1 Subscription Subscription request on UN/CEFACT Code list to be
0012 Catalogue Update frequency of Catalogue referenced
Frequency updates.

2
The short name of the business entity may be changed in the process of developing the Requirement Specification
Mapping (RSM),

Date 2008-11-10, Issue #2 UN/CEFACT Page 31 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
SRQ 0..1 Requested The requested period for the
0013 Subscription period catalogue subscription.
SRQ 0..n Subscription The code specifying the Gives the Catalogue Provider
0014 Request Catalogue subscription request on content information on how the Catalogue
Update Code for update catalogues Receiver (subscription requester)
wants update catalogue (s) to be
arranged.
Code list:
Full – request a subscription of full
catalogue including all updates
Partial – request a subscription of
catalogue update including only all
updated/changed catalogue items
Partial Price - subscription requested
of catalogue update including only
price changed catalogue items
Partial Item – subscription requested
of catalogue update including only
catalogue items with changed item
specification

If more than one code is used in a


subscription the Catalogue Receiver
must use Catalogue Request to
request a specific update catalogue
according to any of the specified
update codes.
SRQ 0..n Subscription Subscription Request of Code list: ISO 639
0015 Requested language(s) of Catalogue
Catalogue information
Language Code
SRQ 0..n Subscription Subscription Request of Code list: ISO 4217
0016 Requested Currency or currencies of the
Catalogue Currency prices, allowances and charges
Code in Catalogue
SRQ 0..1 Subscription Subscription request on validity Result in only one issue of a
0017 Requested period for Catalogue for which catalogue if used.
Catalogue Validity the catalogue must be valid and
Period ready for use.
SRQ 0..n Subscription Subscription request on product Code list (examples):
0018 Requested Product classification scheme(s) - UNSPSC
Classification (including version etc)required
Scheme Code for classifying the products in
the subscribed Catalogue - GPC
- CPV
SRQ 0..n Subscription Requested Product group(s) to Includes a code list of available
0019 Requested Product be included in the Catalogue by Product Classification schemes
Classification Code using Product Classification
Scheme(s)

Date 2008-11-10, Issue #2 UN/CEFACT Page 32 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
SRQ 0..n Subscription Price type(s) to include in the A code list containing different
0020 Requested Price Catalogue price types (examples)
Type Code
- Contract price (net price) Price
according to contract, including
allowances and charges,
excluding taxes

- Contract price (gross price)


Price according to contract,
excluding allowances and
charges and taxes

- Current (today’s) price,


contractual (net price) Price
according to contract, including
allowances and charges,
excluding taxes. This price can
vary from day to day during the
contract period. Price at time of
transaction according to
agreement: E.g fresh food,
flowers, spot price

- Discounted current (today’s)


price (net price), Price according
to the supplier’s price list or
catalogue including allowances
and charges, excluding taxes.
This price can vary from day to
day during the period of time.
Price at time of transaction
according to agreement: E.g fresh
food, flowers, spot price

- Catalogue price, discounted (net


price) Price according to the
supplier's price list or catalogue,
including allowances and
charges, excluding taxes.

- Catalogue price, discounted


(gross price) Price according to
the supplier's price list or
catalogue, excluding allowances,
charges and taxes.

Date 2008-11-10, Issue #2 UN/CEFACT Page 33 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
SRQ 0..n Requested Trading It must be possible to state UBL
0021 Terms requested trading terms and
conditions that apply to all trade
items. Trading terms must be
possible to be given in text
and/or as a reference to where
the trading terms can be found
(URL to national or industry
specific terms). Also the trading
terms can apply to specific
applicable regions/country.
SRQ 0..n Subscription A geographical area, based Code list: ISO 3166
0022 Requested Target upon geographical boundaries
Market(s) sanctioned by the United
Nations, for items which should
be included in the subscribed
catalogue.
SRQ 0..n Subscription A medium-scale area of land for Only items which are delivered to the
0023 Requested Delivery deliveries of items which should requested region are to be included in
Region(s), text be included in the subscribed the subscribed catalogue
catalogue.
SRQ 0..n Subscription A geographical location for Only items which are delivered to the
0024 Requested Delivery deliveries of items which should specified location (s) are to be
Location(s) be included in the subscribed included in the catalogue.
catalogue.

1.7. Catalogue Request (Business Document)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
CRQ
CRQ 1 Catalogue Request The identifier of the Catalogue
0001 Identifier Request
CRQ 0..n Signature To facilitate digital signing of the
0002 catalogue request
CRQ 0..* Catalogue Request A general overall description for Use case: Can be used for the
0003 Description text the Catalogue Request in clear requester to describe the requested
text content of the catalogue.
This description is not an alternative
of using Product groups or Product
classification.
UBL e.g. Computer accessories for
laptops.
CRQ 1..1 Catalogue Receiver Receiver of the Catalogue
0004 Information
CRQ 1..1 Catalogue Provider Provider of the catalogue
0005

Date 2008-11-10, Issue #2 UN/CEFACT Page 34 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CRQ 0..1 Procurement Party The party at the customer side UBL
0006 responsible for negotiating the
contract and the contents of the
catalogue.
CRQ 0..n Supplier party Supplier (s) whose catalogue (s)
0007 is to be provided.
CRQ 0..n Contract Reference Reference to the Contract(s) the
0008 requested Catalogue is subject
of.
CRQ 0..n Document Reference to other document (s) UBL
0009 Reference applicable for the requested
catalogue
CRQ 0..1 Requested Reference to the Catalogue to UBL
0010 Catalogue be updated
Reference
CRQ 0..1 Requested The code specifying the All updates are in comparison with
0011 Catalogue Update requested content of the update the most previous catalogue or in
Code catalogue comparison to the referenced
catalogue to be updated.

Code list:
Full – a full catalogue including all
updates must be provided
Partial – only all the updated/changed
Catalogue Items must be provided
Partial Price - only price changed
catalogue items must be provided
Partial Item – only catalogue items
with item specification changes must
be provided
CRQ 0..n Requested Requested Language(s) for the Code list:
0012 Catalogue requested Catalogue ISO 639
Language(s) Code
CRQ 0..1 Requested Requested Currency of the Code list: ISO 4217
0013 Catalogue Currency prices, allowances and charges
Code in the requested Catalogue
CRQ 0..n Requested Product The product classification Code list
0014 Classification scheme(s) required for UNSPSC
Scheme Code classifying the products in the
requested Catalogue CPV
GS1 GPC
CRQ 0..1 Requested The period for which the
0015 Catalogue Validity requested Catalogue must be
Period valid and ready for use.
CRQ 0..n Requested Product Requested Product group(s) to
0016 Group(s) be included in the Catalogue by
using a Product Classification
Scheme

Date 2008-11-10, Issue #2 UN/CEFACT Page 35 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CRQ 0..n Requested Identification of the requested
0017 Catalogue item Catalogue items to be included
identification in the Catalogue Information
CRQ 0..n Requested Price Requested Price type(s) to A code list containing different
0018 type code include in the Catalogue price types (examples)
- Contract price (net price) Price
according to contract, including
allowances and charges, excluding
taxes
- Contract price (gross price) Price
according to contract, excluding
allowances and charges and taxes
- Current (today’s) price, contractual
(net price) Price according to
contract, including allowances and
charges, excluding taxes. This price
can vary from day to day during the
contract period. Price at time of
transaction according to agreement:
E.g fresh food, flowers, spot price
- Discounted current (today’s) price
(net price), Price according to the
supplier’s price list or catalogue
including allowances and charges,
excluding taxes. This price can vary
from day to day during the period of
time. Price at time of transaction
according to agreement: E.g fresh
food, flowers, spot price
- Catalogue price, discounted (net
price) Price according to the
supplier's price list or catalogue,
including allowances and charges,
excluding taxes.
- Catalogue price, discounted (gross
price) Price according to the
supplier's price list or catalogue,
excluding allowances,charges and
taxes.
CRQ 0..1 Requested Trading It must be possible to state UBL
0019 Terms requested trading terms and
conditions that apply to all trade
items. Trading terms must be
possible to be given in text
and/or as a reference to where
the trading terms can be found
(URL to national or industry
specific terms). Also the trading
terms can apply to specific
applicable regions/country.

Date 2008-11-10, Issue #2 UN/CEFACT Page 36 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CRQ 0..n Requested Target A requested geographical area, Code list: ISO 3166 (country codes)
0020 Market based upon geographical
boundaries sanctioned by the
United Nations, for items which
should be included in the
requested catalogue..
CRQ 0..* Requested Delivery A requested medium-scale area Only items which are delivered to the
0021 Region, text of land for deliveries of items to requested region are to be included in
be included in the requested the catalogue.
Catalogue in clear text.
CRQ 0..n Requested Delivery A requested geographical Only items which are delivered to the
0022 Location location for deliveries of items to specified location are to be included
be included in the requested in the catalogue.
Catalogue.

1.8. Application Response (Business Document)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
ARP
ARP 1..1 Document Generic document.
0001 Information
ARP 1..1 Application The identifier of the Application
0002 Response Identifier Response
ARP 0..n Signature To facilitate digital signing of the UBL
0003 application response
ARP 1..1 Application The code for identifying the Code list:
0004 Response Code application response. A – the received document is rejected
B – the received document is
accepted
ARP 1..1 Application The date/time when the
0005 Response Issue Application Response is issued.
date time
ARP 0..n Coded Reason for Coded reason for rejection. Applicable to use only when code
0006 rejection value A in “Application Response
Code” is used (rejections).
Code list to be provided
The use of the business term must be
agreed by the business parties.
Agreement must be made if the
rejection applies at both business
level and technical level.
ARP 0..* Textual Reason for Reason for rejection in clear Applicable to use only when code
0007 rejection text. value A, is used (rejections) and
coded reason for rejection not used.
The use of the business term must be
agreed by the business parties.

Date 2008-11-10, Issue #2 UN/CEFACT Page 37 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
ARP 1..1 Responded Reference to the responded
0008 Business Document business document
Reference
ARP 1..1 Response Provider The party providing the
0009 Application Response
ARP 1..1 Response Receiver The party receiving the
0010 Application Response
ARP 0..n Response to A response to a line in the UBL
0011 received catalogue received Catalogue
line

1.8.1. Response to received catalogue line (Application Response)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
ARL
ARL 1..1 Line Reference Identifies the line in the NES UBL
0760 referenced document
ARL 1..1 Line Response The code for identifying the line Code list::
0761 Code response. • Accepted
• Rejected
NES UBL
ARL 0..1 Reason for rejection Coded Reason for rejection of Code list?
of catalogue line, the catalogue line
code
ARL 0..* Reason for rejection Reason for rejection of the line NES UBL
0763 of line, text in clear text.

1.9. Catalogue (Business Document)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
CAT
CAT 1..1 Document Generic document.
0001 Information
CAT 1..1 Catalogue Identifier The identifier of the catalogue
0002 collection assigned by the
Catalogue Provider
CAT 0..1 Catalogue Request The reference to the request of
0003 Reference the catalogue.
CAT 0..1 Catalogue The reference to the catalogue
0004 Subscription subscription.
Reference
CAT 0..* Description To provide an general overall UBL e.g. Computer accessories for
0005 description for the Catalogue laptops.

Date 2008-11-10, Issue #2 UN/CEFACT Page 38 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CAT 0..n Signature To facilitate digital signing of the UBL
0006 catalogue
CAT 0..1 Validity period The period in which the Validity period at this header level can
0007 catalogue or catalogue be overridden at a lower level of the
collection is valid catalogue (catalogue item level or
product level)

CAT 1..1 Catalogue status Code giving the status of the Code list:
0008 code catalogue Original – Initial catalogue
Replace - Catalogue replacing a
previous catalogue
Change - Catalogue containing
changed items compared to previous
catalogue
CAT 0..1 Catalogue Reference to the updated or
0009 update/replace, replaced Catalogue
Reference
CAT 0..1 Price List A reference to the price list for Reference to a price list at this header
0010 Reference this catalogue level can be overridden at line level.
A business rule must be made when
using this business term concurrently
with the price list reference at the
level of Trade agreement.
CAT 0..1 Contract Reference A reference to business contract UBL
0011 which the catalogue is based Reference to contract at this header
upon. level can be overridden at line level.
Must be possible to state the contract
reference on header level in cases
where it can not be stated on line
level or where it must be mandated
that only one contract can be
referenced for all lines. Must be
possible to give contract reference for
each supplier.
CAT 1..1 Catalogue Provider The Provider of the Catalogue
0012 Information.
CAT 1..1 Catalogue Receiver The Receiver of the Catalogue
0013 Information
CAT 0..1 Procurement Party The party at the customer side UBL
0014 responsible for negotiating the
contract and the contents of the
catalogue.
CAT 0..1 Supplier Party Party who owns the item and
0015 consigns or makes them
available in trade

Date 2008-11-10, Issue #2 UN/CEFACT Page 39 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CAT 0..1 Delivery Date The date period in which
0016 Period catalogue items may be
delivered
CAT 0..1 Payment The payment instructions
0017 Instructions applicable to the catalogue
CAT 0..1 Payment Terms The payment term applicable to
0018 the catalogue
CAT 0..n Target market A geographical area based upon Target market at this header level can
0019 geographical boundaries be overridden at line level.
sanctioned by the United
Nations, in which the trade items
mentioned in the catalogue are Code list: ISO-3166
available.
CAT 0..* Delivery Region, A medium-scale area of land to Delivery region at this header level
0020 text which the items mentioned in can be overridden at line level.
the catalogue can be delivered.
CAT 0..n Delivery Location A geographical location to which Delivery location at this header level
0021 the items mentioned in the can be overridden at line level
catalogue can be delivered.
Catalogue detail level
CAT 0..1 Line Count Numeric The number of lines in the UBL has Items in Lines, the lines
0022 catalogue containing the extrinsic item
information such as pricing.
CAT 1..n Catalogue Item The information of a catalogue
0023 item.

1.9.1.1. Catalogue Item (Catalogue)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
CAI
CAI 1..1 Catalogue Item The identification of the A continuous number or a logical ID?
0100 Identification catalogue item according to a Or an unambiguous global unique
cataloguing system identity?
UBL – Catalogue Item Identification in
Item
CAI 1..1 Catalogue item The code specifying the action UBL – Action Code in Catalogue Line
0101 action code valid for the catalogue item GS1
Code list:
- New (added) catalogue item
- Updated catalogue item
- Replaced catalogue item
- Deleted catalogue item
CAI 0..1 Trade Item A code assigned by the supplier GS1
0125 Grouping Code or manufacturer to logically
group trade items independently
from classification systems.

Date 2008-11-10, Issue #2 UN/CEFACT Page 40 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CAI 0..1 Trade Item The corresponding name in GS1
0126 Grouping Name clear text for the grouping code
of a trade item.
CAI 0..1 Catalogue item Code indicating availability of UBL
0102 availability Code the Catalogue Item Code list:
new, available – new and available
catalogue item
new, not available – new not available
catalogue item, announcement only
deletion, announcement –
announcement for a future deletion of
a catalogue item
CAI 0..1 Catalogue Item The party who provides the UBL
0103 Information catalogue item information. GS1
Provider Party
CAI 0..1 Trade Item Indicates the date period the GS1
0104 Shipping Period catalogue item can be shipped.
CAI 0..1 Catalogue item The period during which the UBL
0105 information Validity information provided for the GS1
period catalogue item is valid.
CAI 0..1 Catalogue item The date time on which the GS1
0106 information Change catalogue item data was last
latest date time changed
CAI 0..n Multimedia Multimedia presentation of the UBL
0107 presentation item (e.g. picture or drawing)
CAI 0..1 Additional Provides more details of the UBL
0108 Information item (e.g., the URL of a
relevant web page).
CAI 0..* Additional Additional information in clear UBL
0109 Information Note, text about the item not already Not GS1
text given as structured information
To be used as non-structured
information
CAI 0..* Keyword, text A text string or synonyms to be UBL
0110 used for searching for the
catalogue item.
CAI 0..n Replacing References to catalogue items UBL
0111 Catalogue item that can replace or substitute Not GS1
the catalogue Item
CAI 0..n Accessory Product Relation to accessories or UBL
0112 attachments to the catalogue Not GS1
Item e.g. headphones to a
mobile phone
CAI 0..n Required Product Relation to a required product to UBL
0113 the Catalogue Item e.g. a
subscription to a mobile phone
CAI 0..n Complementary Relation to products that UBL
0114 Product compliments the Catalogue Item
e.g. coal for a barbecue

Date 2008-11-10, Issue #2 UN/CEFACT Page 41 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
CAI 0..n Component Product Relation to components or parts UBL
0115 to the product e.g. an ink
cartridge for a printer
CAI 0..n Additional Product Relationship to other products UBL
0116 relation other than replacing product, Not to be mistaken for hierarchy
accessory product, required information.
related product, complementary
product and component
product..
CAI 0..1 Catalogue Item The indicator indicating that the GS1
0118 Reorderable catalogue item may be Indicators:
Indicator reordered.
True, False
CAI 0..n Tracking System Identifies a system by which the e.g UK National joint implant register
0119 Identifier product is being tracked Code list of tracking systems to be
developed
CAI 0..n Target market A geographical area based upon
0120 geographical boundaries
sanctioned by the United
Nations, in which the catalogue
items are available.
CAI 0..n Tax Information Information about all applicable If needed Tax information recurs per
0121 taxes for the catalogue item each tax type (Tax Type Code).
CAI 0..1 Trade Agreement Information on trade
0122 agreements
CAI 0..1 Trade Delivery Information on trade deliveries.
0123
CAI 1..1 Product Information on the product
0124 (trade item).

1.9.1.2. Tax Information (Catalogue Item)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
TXI
TXI 1..1 Tax Type Code The code indicating the type of Examples of Tax Types:
0200 tax - Alcohol tax
- Value added tax (VAT)
- Environmental tax
- Goods and services tax
- Coffee tax
Code list UN/CEFACT 5153
TXI 0..1 Tax Type Description of tax type code. GS1
0201 Description

Date 2008-11-10, Issue #2 UN/CEFACT Page 42 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
TXI 1..1 Tax Category Code Code specifying a duty or tax Examples of Categories:
0202 or fee category - Exempt from tax
- Standard rate
Code list UN/CEFACT 5305
TXI 0..1 Tax exemption Information about the reason for Used when the catalogue line is
0203 reason exemption of tax, coded or in exempt from tax. (used when Tax
clear text Category is specified as exempt from
tax)

TXI 0..1 Tax Rate The percentage value of the tax


0204 Percentage rate when specified in
percentage
TXI 0..1 Tax Rate Monetary The monetary value of the tax Example:
0205 amount rate when specified as a Electricity tax can be specified as an
monetary amount (for a amount per kilowatt hour.
specified currency)
TXI 0..n Tax location A country or other geographical GS1
0206 area to which a specific tax is Example
applicable.
Depending on the region the
electricity tax is different (Sweden).
TXI 0..n Tax Agency Code A code identifying the (national) GS1
0207 agency responsible for the tax
code list.

1.9.1.3. Tax Exemption (Tax Information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
TXE
TXE 0..1 Reason for A code for the reason for tax
0210 exemption, code exemption.
TXE 0..1 Reason for Reason for tax exemption in
0211 exemption, text clear text.

1.9.1.4. Trade Agreement (Catalogue Item)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
TAG
TAG 0..1 Procurement Party The party at the customer side UBL – Contractor Customer Party in
0220 responsible for negotiating the Catalogue Line
contract and the contents of the
catalogue.
Provides for a multi customer
catalogue
TAG 0..1 Supplier Party Party who owns the product and UBL
0221 consigns or makes them Not GS1
available in trade and
Provides for multi supplier catalogue.

Date 2008-11-10, Issue #2 UN/CEFACT Page 43 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
TAG 0..n Trading Terms It must be possible to state UBL
0222 trading terms and conditions
that apply to all trade items.
Trading terms must be possible
to be give in text and/or as a
reference to where the trading
terms can be found (URL to
national or industry specific
terms). Also the trading terms
can apply to specific applicable
regions/country.

TAG 0..1 Contract Reference The reference to a Contract. Provides for multi supplier catalogue.
0223
TAG 0..1 Contract A text giving a subdivision of a UBL
0224 Subdivision text contract or tender. Examples "Installation", "Phase One",
Support and Maintenance"
TAG 0..1 Price Contract The reference to a contract
0225 Reference specifying the price conditions.
TAG 0..1 Customer Support The customer support centre for GS1
0226 Centre - Party the catalogue item.
TAG 0..1 Restricted The indicator to qualify that Indicators:
0227 information catalogue item information is True, False
indicator restricted to specific use
according to agreement.
TAG 0..1 Product Ordering The period of date the catalogue GS1
0228 Period item (product) can be ordered.
TAG 0..1 Product Exclusivity The date and time at which a GS1 – special exclusivity
0229 end date time catalogue item (product)no agreements between brand owner
longer is exclusive to the trading and a buyer (retailer)
partner
TAG 0..1 Availability To The first date/time the buyer is GS1
0230 Consumer Start allowed to resell the catalogue
Date and Time item (product).
TAG 0..1 Product First The earliest date at which the GS1
0231 Delivery Date supplier can deliver the
catalogue item (product) to the
trading partner.
TAG 0..1 Minimum product A number of days from the GS1
0232 lifespan from time arrival date, guaranteed by the
of arrival, Days manufacturer, before the
expiration date of the product.
TAG 0..1 Orderable indicator The indicator identifying that the UBL
0235 catalogue item may be ordered GS1
Indicators:
True, False
TAG 0..1 Made to Order Indicates that the item will only Not GS1
0236 Indicator be produced when the Indicators:
manufacturer receives an order
True, False

Date 2008-11-10, Issue #2 UN/CEFACT Page 44 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
TAG 0..n Trade Item Delivery The time taken from the time of UBL
0237 Lead Time order to the time of delivery for GS1
the Item in a specific delivery
quantity to a specific delivery
location or region.
TAG 0..1 Catalogue Item Pick The earliest time an ordered GS1
0238 Up Lead Time catalogue item is available for
pick up expressed as weeks,
days, hours (etc).
TAG 0..1 Catalogue Item The incremental quantity in UBL
0239 Order Incremental which the product must be GS1
Quantity ordered e.g. 10 = orders of 10,
20, 30 etc can be ordered.
TAG 0..1 Catalogue Item The minimum quantity of the UBL
0240 Minimum Order product which must be ordered GS1
Quantity
TAG 0..1 Catalogue Item The date period for when the GS1
0241 Minimum Order minimum order quantity is
Quantity Date available for ordering
Period
TAG 0..1 Catalogue Item The maximum quantity of the UBL
0242 Maximum Order catalogue item available for GS1
Quantity ordering
TAG 0..1 Catalogue Item The date period for when the GS1
0243 Maximum Order maximum order quantity is
Quantity Date available for ordering
Period
TAG 0..1 Ordering Unit Of The unit of measure for the GS1
0244 Measure ordering of the catalogue item - code list UN/ECE rec 20
(product).
Examples of codes for use :
KGM – the item is to be ordered in
kilograms
EA – the item is to be ordered in each
LTR - the item is to be ordered in litre
TAG 0..1 Selling Unit Of The unit of measure for the GS1
0245 Measure selling of the product to the end - code list UN/ECE rec 20
consumer.
Examples of codes for use :
KGM – the item is to be sold in
kilograms
EA – the item is to be sold in each
LTR - the item is to be sold in litre
TAG 0..1 Purchase Conditions applying to the sale UBL
0246 Conditions or purchase of the catalogue Class in UBL "Information about
item purchasing, sales, or payment
conditions." Contains: ID,
ActionCode, Description and
DocumentReference
Class have to be developed.

Date 2008-11-10, Issue #2 UN/CEFACT Page 45 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
TAG 0..* Warranty Warranty information text about UBL
0247 Information text the catalogue item. (GS1- used in “GS1 XML extension”
for Hard Lines)
TAG 0..n Price information Price(s) information applied to
0248 the product within trade
agreement
TAG 0..1 Delivery terms The entity contains the delivery
0249 terms and if relevant the location
related to the delivery terms.
TAG 0..1 Marketing Marketing information about the
0250 catalogue item

1.9.1.5. Price information (Trade agreement)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PRI
PRI 0..1 Price List A reference to the price list used UBL
0270 Reference for the pricing of the catalogue A business rule must be made when
item. using this business term concurrently
with the price list reference at the
catalogue header level.
PRI 0..1 Catalogue Item The price amount for the UBL
0271 Price amount catalogue item

Date 2008-11-10, Issue #2 UN/CEFACT Page 46 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRI 0..1 Price Amount Type The code for the Price Type of UBL
0272 Code the price amount Examples of Price types to include in code
list for “Price type code” :
- Suggested Retail Price
By the manufacturer suggested retail price
to consumer. Normally used to establish a
proposed value for the trade item. May or
may not appear on the package.
- Contract price (net price) Price according
to contract, including allowances and
charges, excluding taxes
- Contract price (gross price) Price
according to contract, excluding
allowances and charges and taxes
- Current (today’s) price, contractual (net
price) Price according to contract,
including allowances and charges,
excluding taxes. This price can vary from
day to day during the contract period.
Price at time of transaction according to
agreement: E.g fresh food, flowers, spot
price products
- Discounted current (today’s) price (net
price), Price according to the supplier’s
price list or catalogue including
allowances and charges, excluding taxes.
This price can vary from day to day during
the period of time. Price at time of
transaction according to agreement: E.g
fresh food, flowers, spot price products
- Catalogue price, discounted (net price)
Price according to the supplier's price list
or catalogue, including allowances and
charges, excluding taxes.
- Catalogue price, discounted (gross
price) Price according to the supplier's
price list or catalogue, excluding
allowances, charges and taxes.
- Additional Price Another price type
different from coded price types
PRI 0..1 Additional Price The code for an additional price UBL
0273 Amount Type Code amount type for the item apart
from qualified price types.
PRI 0..1 Price Basis The quantity of the Item to which
0274 Quantity the applicable valid price applies
PRI 0..n Allowance Charge An association to charges and UBL
0275 discounts for the Catalogue Item

PRI 0..* Price Change The reason for the price UBL
0276 Reason Text change expressed as text
PRI 0..n Validity Period for The period(s) for which the UBL
0278 Price price is valid
PRI 0..1 Bracket Price The quantity range (minimum, Not GS1
0279 Quantity Range maximum) of the item for which
the price is valid

Date 2008-11-10, Issue #2 UN/CEFACT Page 47 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRI 0..n Price Validity A delivery location(s) for which UBL
0280 Location the price is valid.

PRI 0..1 Price Comparison Information about details UBL


0281 for price comparison of the GS1
product

1.9.1.6. Price List Reference (Price information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PLR
PLR 0..1 Price List Identifier The identifier for the Price List UBL
0283

PLR 0..1 Validity Period The period(s) for which the UBL
0284 price list is valid

PLR 0..1 Immediate Previous A reference to a immediate UBL


0285 Price List previous Price List
Reference

1.9.1.7. Price Comparison (Price Information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PRC
PRC 1..1 Comparison Price The price for the comparison UBL
0290 Amount quantity of the trade item in
respect to the price comparison
type (code)
PRC 1..1 Price Comparison The quantity used for price UBL
0291 Quantity comparison with other items. GS1

Date 2008-11-10, Issue #2 UN/CEFACT Page 48 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRC 1..1 Price Comparison Code indicating how price GS1
0292 Type Code comparison is made. How to Code list: “GS1
calculate the comparative price. PriceComparisonContentType”
DRAINED_WEIGHT - The weight of
a product when all liquids used in the
packaging of the product have been
removed.
INCLUDING_ADDITIVES - Specified
using MLT or FZ as unitOfMeas-ure
(price per litre/pint drink including
addi-tives other than water). Food
service.
MILLILITRES_EXCLUDING_DEPOSI
T - Specified using MLT as
unitOfMeasure (price per litre, not
including the package deposit charge)
PER_CUBIC_METRE - The Price
Comparison Content specified may
be used to calculate the price per
cubic metre.
PER_DOSE - Specified using PCE as
unit of measure.
PER_KILOGRAM - Specified using
GRM as unitOfMeasure (price per
kilogram).
PER_LITRE - Specified using MLT as
unitOfMeasure (price per litre).
PER_LOAD - Specified using PCE as
unit of measure (price per load - used
for washing up powder).
PER_METRE - Specified using MMT
as unitOfMeasure
PER_PIECE - Specified using PCE
as unitOfMeasure (price per piece)
PER_PINT - Specified using FZ as
unitOfMeasure (price per pint)
PER_POUND - Specified using OZ
as unitOfMeasure (price per pound)
PER_SQUARE_METRE - The Price
Comparison Content specified may
be used to calculate the price per
square metre.
PER_WASH - Specified using PCE
as unitOfMeasure (price per wash –
used for washing detergent).
PER_YARD - Specified using IN as
unitOfMeasure (price per yard)
READY_TO_DRINK - Specified using
MLT or FZ as unitOfMeasure (price
per litre/pint diluted drink).
READY_TO_EAT - Specified using
GRM or OZ as unitOfMeas-ure (price
per kilogram/pound prepared food).

Date 2008-11-10, Issue #2 UN/CEFACT Page 49 of 75


Business Requirements Specification Catalogue

1.9.1.8. Trade Delivery (Catalogue Item)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
TDY
TDY 0..1 Handling The specific instructions for
0300 Instructions storage, transport or handling of
the product.
TDY 0..1 Carrier Party The party which provides
0301 transport services.
TDY 0..n Production Batch An identification of the
0302 Identification production batch of the product.
TDY 0… Import A code indicating the import GS1
0303 1 Classification Code classification code list used for Imports and exports of trade items
List Type Code the trade item. require classification codes to
determine appropriate duties and
tariffs.
Code list:
- CUSTOMS_TARIFF_NUMBER
-
HARMONIZED_COMMODITY_D
ESCRIPTION_AND_CODING_S
YSTEM
-
HARMONIZED_TARIFF_SCHED
ULE_OF_THE_US
- INTRASTAT
-
INTRASTAT_COMBINED_NOME
NCLATURE
- NETHERLANDS
-
TARIF_INTEGRE_DE_LA_COM
MUNAUTE

TDY 0..1 Import The used value from the GS1


0304 Classification Value according import classification
code list for the trade item

1.9.1.9. Product (Catalogue Item)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PRO
PRO 1..1 Product The identification(s) for the UBL
0312 Identification product GS1
(including Product. Identification,
Global Identification, Seller Assigned
Identification, Buyer Assigned
Identification, Manufacturer Assigned
Identification, Industry Assigned
Identification)

Date 2008-11-10, Issue #2 UN/CEFACT Page 50 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRO 0..n Official regulations A code that indicates that a GS1
0318 compliance code product is in compliance with Code list: different code lists for
specific applicable official different kind of products
regulations

PRO 0..1 Consumer unit Indicator identifying the product GS1


0319 indicator as a consumer unit. Indicators:
True, False
PRO 0..1 Despatch unit The indicator identifying that the GS1
0320 indicator product may serve as a dispatch Indicators:
(shipping) unit
True, False
PRO 0..1 Product Launch The cancellation date of the GS1
0321 Cancellation date launch of a product that was
never and will never be
manufactured, but may have
been presented to buyers.
PRO 0..1 Manufacturer Party The party who makes the UBL
0322 product (not to imply a party
who simply provides packaging
of the product)
PRO 0..1 Product rights The party who owns the rights of
0323 owner party the product
PRO 0..1 Minimum product A number of days from the GS1
0362 lifespan from time production date, guaranteed by
of production, Days the manufacturer, before the
expiration date of the product
PRO 0..1 Opened Product The number of days remaining GS1
0363 Lifespan, Days from the time of break opening (for retail - information about when
of the packaging of the product product to be removed from the shelf)
until not good for consuming
PRO 0..1 Product The date on which the product is GS1
0324 Discontinued date no longer produced.
PRO 0..1 Product Change The date time on which the GS1
0325 latest date time product data was last changed
PRO 0..* Product Name Text The name of the product which UBL
0326 distinguish it from other products
and if necessary to be used in
trade messages such as order
and invoice.
PRO 0..* Product Functional A description of the use of the GS1
0327 Description Text product.
PRO 0..* Product Description A short description of the GS1
0328 Short Text product which can be used on
shelf edge and on receipts.
PRO 0..1 Model Name The model name UBL
0329

Date 2008-11-10, Issue #2 UN/CEFACT Page 51 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRO 0..* Additional Product An additional description of the UBL
0330 Description Text product. GS1

PRO 0..* Variant description A description used to identify the GS1


0331 Text variant of the product. Variants
are the distinguishing
characteristics that differentiate
items with the same brand and
size including such things as the
particular flavour, fragrance,
taste.
PRO 0..1 Product Brand The brand name of the product UBL
0332 Name GS1

PRO 0..1 Sub Brand Name Second level of brand name for GS1 – E.g. trademark. It is the
0333 the product. primary differentiating factor that a
brand owner wants to communicate
to the consumer or buyer. E.g.
Yummy-Cola Classic. In this example
“Yummy-Cola” is the brand name and
“Classic” is the subBrand.
PRO 0..* Descriptive Form A description of the physical GS1
0334 Text form or shape of the product.
Used, for example, in
pharmaceutical industry to
indicate the formulation of the
trade item. Defines the form the
trade item takes and is distinct
from the form of the packaging.
Examples: paste, gel, powder
PRO 0..1 Product Quantity The quantity of the product GS1
0335 contained in the product (trade UBL
item) (incl measurement unit
code according to UN/ECE
recommendation 20 /
UN/CEFACT code list 6411)

PRO 0..1 Quantity Of Product Indicates the number of non- GS1


0336 Contained In Inner coded physical groupings (inner
Pack packs) of next lower level trade
items within the current level.
PRO 0..1 Product Drained The weight of the product of the GS1
0337 Weight trade item when drained of its
liquid.
PRO 0..1 Trade Item Variable Indicator identifying the trade GS1 - Boolean true/false
0338 Measure Indicator item as a variable measure
trade item. The content of the
trade item vary about either
weight, length or volume (or
other)

Date 2008-11-10, Issue #2 UN/CEFACT Page 52 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRO 0..1 Country of origin The code for the country in UBL
0339 Code which (where) the product has GS1
been produced or manufactured
Code list: ISO 3166
PRO 0..1 Subdivision Country A code for subdivision of countyr UBL
0340 of Origin code of origin (state, province or
region) in which the product has
been produced or manufactured
PRO 0..1 Country of The country where the product Code list: ISO 3166
0341 assembly is assembled.
PRO 0..1 Product Colour A code for describing the colour A code list is required to identify the
0342 Code of the product. colour of the product. No ISO
standards exist. Each industry needs
to determine which code agency it will
use (e.g NCS-natural color system)
Colour can also be specified by using
Property
PRO 0..* Product Colour A clear text describing the Not to be used if code for colour is
0343 Description colour of the product. used
One occurrence for each language
Colour can also be specified by using
Property
PRO 0..1 Product Prepack A code specifying if the content E.g. a trade item containing plastic
0344 Type Code of the product is pre-packed or bags with apples is of the type "pre-
contains loose products. packed". A trade item containing
loose apples is of the type "loose".
GS1 – code list
Code list:
PRE-PACKED
LOOSE
PRO 0..1 Customer A code indicating that the Code list: yes/no/not used
0345 Configurable Code customer may configure the
item
PRO 0..1 Recyclable type A code specifying the recyclable Code list for available recycleable
0346 code sign marked on the product. signs to be developed.
PRO 0..1 Product marked Indicate if a serial number is Not GS1
0347 with Serial number marked on the product. True/false
Indicator
PRO 0..1 Security tag type A code indicating the type of GS1
0348 Code security tag on the product Code list:
Acousto-Magnetic
Electro-Magnetic
Ink or dye
Microwave
Radio Frequency.

Date 2008-11-10, Issue #2 UN/CEFACT Page 53 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PRO 0..1 Security tag A code specifying where the GS1
0349 location Code security tag is located on the Code list:
product On outside
Concealed inside
Integrated Inside
PRO 0..n Product Unit An association to actual UBL
0350 instance(s) of the Product
PRO 0..1 Hazardous The information regarding UBL
0351 information hazardous and dangerous
characteristics of the product.
PRO 0..1 Package Information about how the
0352 information product is packed e.g. package
type
PRO 0..1 Logistic unit The information about the
0353 information configuration of the logistic unit
(e.g pallet, roll cage) Only to be
used when the product is the
logistic unit and has no unique
identification (e.g a GTIN).
(Equivalent info on logistic units
with unique identification is
found in the class “Hierarchy
Information”)
PRO 0..1 Hierarchy Description of product hierarchy, GS1
0354 information multi pack and product Not to be mistaken for item relation
composed by more than one class
product.
Cardinality is 1..1 for multi pack
product (contain products with same
id)
Cardinality is 1..1 for mixed pack
product (product composed by more
than one product)
The class is not used for the product
at the lowest level (base unit).
PRO 0..1 Physical The physical dimensions of the
0355 Dimensions product.
PRO 0..n Property A technical property of the
0357 product
PRO 0..n Product Class Classification of the product UBL
0358

PRO 0..n Product Material The material(s) of which the


0359 product is composed
PRO 0..n Product Information A reference to another Example
0360 Representation representation format for - ontoML representation of the
Reference product information. product
- BMEcat
- Dicalis

Date 2008-11-10, Issue #2 UN/CEFACT Page 54 of 75


Business Requirements Specification Catalogue

1.9.1.10.Product Identification (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PID
PID 1..1 Identification of the An identifier for the Product UBL
0370 product
PID 0..1 Used Product The used system for Code list UN/CEFACT 7143
0371 Identification identification of the Product
System
PID 0..1 Identification An association to the Party UBL
0372 Issuing Party issuing the Item Identification

PID 0..1 Product An association to the Party that UBL


0374 Identification issued the Item Identification
Issuing Party
PID 0..1 Extended An extended identifier for the UBL
0375 Identification of the item that identifies the item with
product specific properties, e.g., Item
123 = Chair / Item 123 Ext 45 =
brown chair.
PID 0..n Identifying Physical Physical attribute(s) of the UBL
0376 Attribute product for additional
identification of the product
PID 0..n Identifying Measurement(s) of the product UBL
0377 Measurement for additional identification of the
Dimension product

1.9.1.11.Marketing (Trade Agreement)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
MAR
MAR 0..n Campaign A specific campaign to market GS1
0400 the product.
MAR 0..1 Additional The link (e.g. URL) to a GS1
0401 Marketing additional document.
Document
Reference
MAR 0..1 Product Range A name, used by the brand GS1
0402 Name owner, that span multiple
consumer categories or uses.
( E.g. Waist Watchers,).
MAR 0..1 Brand Owner Party Name and identification of the GS1
0403 party who owns the brand of the May or may not be the same party as
product. the information provider.
MAR 0..n Product Organic Indicates the code for organic GS1
0404 Code status of a product or of one or
more of its components for
marketing purpose.

Date 2008-11-10, Issue #2 UN/CEFACT Page 55 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
MAR 0..n Organic Claim Indication of the governing body GS1
0405 Agency that determines if products can
claim to be organic for
marketing purpose
MAR 0..* Health Claim Text Free text field for any health
0406 claims according to regulations
of the target market.
MAR 0..n Trade Item_ A code used for identifying GS1
0407 Marketing Special specific items for promotional or code list:
Item Code special tracking purposes
GIFT_WITH_PURCHASE
MAR 0..* Trade Item Feature Description in clear text to GS1
0408 Benefit Text describe the key features or
benefits of the product/trade
item. Used e.g for display
purposes.
MAR 0..1 Season period Date Indicates the period for a GS1
0409 and Time seasonal product.
MAR 0..* Trade Item Marketing message for a trade GS1
0410 Marketing Message item to use towards the Format up to 1000 alfanumerics
consumer.
MAR 0..1 Descriptive Size An alphanumeric size factor of GS1
0411 Text the product . IE Jumbo, Capri,
Full Length, Maxi . (Multi
language)
MAR 0..* Applicable Season, Season(s) applicable to the item GS1
0412 text in clear text.
MAR 0..n Season Parameter, Code indicating the season, in GS1
0413 code which the trade item is available, Code list:
i.e. assignment to one of the
following collection periods: Autumn
spring/summer, autumn/ winter Spring
or all year around. Summer
Winter
All_year
MAR 0..1 Consumer Age, text The age of the targeted GS1
0414 consumer age range for which
the product has been designed
in clear text.
MAR 0..1 Consumer Gender, The gender of the targeted GS1
0415 text consumer for which the trade
item (product) has been
designed. In clear text
MAR 0..n Marketing Feature A marketing feature of the
0416 product, such as target
consumer group.

Date 2008-11-10, Issue #2 UN/CEFACT Page 56 of 75


Business Requirements Specification Catalogue

1.9.1.12.Campaign (Marketing)
UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
CAM
CAM 0..1 Product Marketing The name of a marketing GS1
0420 Campaign Name campaign of a product.
CAM 0..1 Product marketing The period for the marketing GS1
0421 campaign period campaign of a product.

1.9.1.13.Warranty information (Trade Agreement)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
WAI

WAI 0..1 Warranty Party An association to the party UBL


0430 providing warranty of the Item
on the Catalogue Line
WAI 0..1 Warranty Validity An association to the validity of UBL
0431 Period the warranty of the Item on the
Catalogue Line

1.9.1.14.Dimensions (Product)
UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
DIM
DIM 0..1 Product Material The measured area weight of GS1
0440 Area Weight the material. (expressed in ounces per square yard
or grams per square meter)

DIM 0..1 Product Gross The gross weight of the product GS1
0441 weight (includes all packaging materials (At pallet level the item Gross Weight
of the product) includes the weight of the pallet itself)
DIM 0..1 Product Height The height of the product. The GS1
0442 vertical dimension from the
lowest extremity to the highest
extremity, including packaging.
(At a pallet level the item Height
will include the height of the
pallet itself.)
DIM 0..1 Product depth The depth of the product. GS1
0443 Measured from front to back of Measurements are relative to how the
the product. customer normally views the trade
item. May be needed to be
associated with a valid UoM.

Date 2008-11-10, Issue #2 UN/CEFACT Page 57 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
DIM 0..1 Product width The measurement from left to
0444 right of the product.
Measurements are relative to
how the customer normally
views the trade item. Needs to
be associated with a valid UoM.
DIM 0..1 Product diameter The measurement of the GS1
0445 diameter of the product at its For example, 165 "mmt", value - mmt,
largest point. diameter. Has to be associated with
valid UoM.

1.9.1.15.Handling Instructions (Trade Delivery)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
HAI
HAI 0..1 Stacking factor The number of levels the item or GS1
0460 package may be stacked
HAI 0..1 Maximum stacking The maximum admissible GS1
0461 weight weight that can be stacked on
the item or package.
HAI 0..1 Delivery to The permitted maximum GS1
0462 distribution centre temperature of the item or
temperature package on transport to the
maximum distribution centre.
HAI 0..1 Delivery to The permitted minimum GS1
0463 distribution centre temperature of the item or
temperature package on transport to the
minimum distribution centre.

HAI 0..1 Delivery to market The permitted maximum GS1


0464 temperature temperature of the item or
maximum package during delivery to
market
HAI 0..1 Delivery to market The permitted minimum GS1
0465 temperature temperature of the item or
minimum package during delivery to
market to market
HAI 0..1 Storage The maximum temperature at GS1
0466 temperature which the item or package can
maximum be stored.
HAI 0..1 Storage The minimum temperature at GS1
0467 temperature which the item or package can
minimum be stored.
HAI 0..1 Storage humidity The maximum humidity in GS1
0468 maximum percentages that the item or
package should be stored in

Date 2008-11-10, Issue #2 UN/CEFACT Page 58 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
HAI 0..1 Storage humidity The minimum humidity in GS1
0469 minimum percentages that the item or
package should be stored in
HAI 0..* Instruction text Specific handling instructions in
0470 text format (e.g. lift
requirements)

1.9.1.16.Hazardous Information (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
HZI
HZI 0..1 Dangerous goods The code specifying a GS1
0500 regulation code dangerous goods regulation. E. g. ADR (European Agreement
Concerning the International Carriage
of Dangerous Goods by Road)
Code list:
HZI 0..n Dangerous Goods An identification of the hazard GS1
0501 Hazard Class class applicable to the
dangerous substance or product
as defined by the relevant
regulation authority, such as the
IMDG class number of the
SOLAS convention of IMO or
the ADR/RID class number of
the road/rail environment.
Describes the type of
dangerousness.
Dangerous goods classification
of the trade item. There are 9
danger classes, some classes
are further subdivided into
subclasses. "Class" number
explains in general terms the
nature and properties of the
goods and serves to classify
them together in terms of their
most significant risk.
HZI 0..1 Dangerous Goods Identifies the degree of risk the GS1
0502 Packing Group dangerous goods present during
transport according to
IATA/IMDG/ADR/RID
regulations.
HZI 0..1 Dangerous Goods Dangerous goods hazard ID GS1
0503 Hazardous Code number, which must be applied
Identifier to the vehicle, when transporting
this trade item (dangerous good)
by road or rail, to inform the
police, the fire brigade and
others in case of an accident
about the kind of danger caused
by the cargo.

Date 2008-11-10, Issue #2 UN/CEFACT Page 59 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
HZI 0..1 Dangerous Goods Code indicating whether GS1
0504 AMargin Number facilitations for the transport of Information, whether for the base
defined limited quantity by road trade item or further packaging trade
or rail are possible or not. (code item a dangerous goods a-margin
according to ADR) number does exist in the European
dangerous goods agreements (and in
the respective national dangerous
goods legislation), thus facilitations
for the transport of defined limited
quantity by road or rail are possible or
not. If they are possible, they must be
indicated, whether they are used by
the data supplier.
Example: LQ0 = Not limited quantity
Code list: according to ADR

HZI 0..1 Dangerous goods The name of the dangerous GS1


0505 regulation name substance or product as
provided in the list of dangerous
goods regulations.
HZI 0..1 Dangerous goods Provides the details of GS1
0506 technical name hazardous information.
Chemical term of the trade item,
listed by name and allowed in
the substance list of GGVS
(Dangerous Goods Ordinance
for Roads) or GGVE
(Dangerous Goods Ordinance
for Rail). The name by which as
dangerous substance or product
may be correctly identified or
which is sufficient information to
permit identification by reference
to generally available literature.
HZI 0..n Dangerous Goods Shipping name of the trade item GS1
0507 Shipping Name (dangerous goods). The
recognized agencies (see
dangerousGoodsRegulationsCo
des), in their regulations,
provide a list of all acceptable
proper shipping names.
HZI 0..1 United Nations The four-digit number assigned GS1
0508 Dangerous goods by the United Nations
(UNDG) Committee of Experts on the
Identificiation Transport of Dangerous Goods
to classify a substance or a
particular group of substances.
Abbreviation: UNDG Number.
HZI 0..1 Flash point The lowest temperature at which GS1
0509 temperature a substance gives off a sufficient
vapor to support combustion.
HZI 0..n Material Safety The identity of a Material Safety GS1
0510 Data Sheet Data Sheet for the product The Identity of a MSDS is to be
Reference provided in this element.

Date 2008-11-10, Issue #2 UN/CEFACT Page 60 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
HZI 0..1 Hazardous Party to be contacted with Not GS1
0511 information contact relation to the product
hazardous information

1.9.1.17.Hierarchy Information (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
HII
HII 0..1 Number (quantity) The number (quantity) of GS1
0520 of different products different unique products
contained in a contained in a mixed product. A
mixed product mixed product may contain 2 or
more different products.
HII 0..1 Product Total Total quantity of products that GS1
0521 Quantity this product contains.
HII 1..n Next lower product Information on next lower GS1
0522 level information. product level. Cardinality is 1..1 for multi pack
(products with same id)
Cardinality is 1..n for mixed packs
(product composed by more than one
product)

1.9.1.18.Next lower product level information (Hierarchy Information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
NLL
NLL 1..1 Product The unique identification of the GS1
0523 Identification of a product contained in an
product contained identified product.
in a product UBL

NLL 1..1 Quantity Of The quantity of products GS1


0524 Products contained contained in the product
in a product

1.9.1.19.Additional Product Relation (Catalogue Item)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
APR
APR 1..1 Item identification The identification of the related not GS1
0530 catalogue item.
APR 1..1 Relation type The code specifying the type of not GS1
0531 relation between items code list?

Date 2008-11-10, Issue #2 UN/CEFACT Page 61 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
APR 0..1 Related item The quantity of related not GS1
0532 quantity catalogue items, e.g. next lower
level item that this item contains.
APR 0..* Additional A textual description of or other not GS1
0533 Information information about the relation.

1.9.1.20.Marketing Feature (Marketing)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
MAF
MAF 0..1 Type The type of Marketing Feature.
0550
MAF 0..1 Type description The description of the type of
0551 Marketing Feature.
MAF 0..1 Definition The definition of the type of
0552 Marketing Feature.
MAF 0..n Coded value The coded value(s) of the
0553 marketing feature.
MAF 0..* Text value The textual value(s) of the
0554 marketing feature.
MAF 0..n Measurement Measured value(s) of the
0555 marketing feature.

1.9.1.21.Marks and Labels (Package Information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
MAL
MAL 0..n Barcode type The type of bar code or codes, GS1
0570 marked on which are visible on the product Code list:
package, code or package.
COMPOSITE_COMPONENT_A -
The Composite symbology
integrates both a GS1 System
linear symbol and a 2D
Composite Component as a
single symbology.
COMPOSITE_COMPONENT_B -
The Composite symbology integrates
both a GS1 System linear symbol and
a 2D Composite Component as a
single symbology.
COMPOSITE_COMPONENT_C -
The Composite symbology integrates
both a GS1 System linear symbol and
a 2D Composite Component as a
single symbology.
EAN_UCC_13_SYMBOL – ISO
certified barcode used for GTIN-13.
EAN_UCC_8_SYMBOL – ISO

Date 2008-11-10, Issue #2 UN/CEFACT Page 62 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
certified barcode used for GTIN-8.
ITF_14_SYMBOL – ISO certified
barcode used for GTIN-14.
GS1_128_SYMBOL – ISO certified
barcode used for information using
GS1 128 standard.
UPC_A_SYMBOL – Barcode used
for GTIN-12.
UPC_E_SYMBOL – Barcode used
for representing a GTIN-12 in six
explicitly encoded digits using zero-
suppression techniques
GS1_DATABAR_OMNIDIRECTIONA
L – Barcode used for any of GTIN-8
GTIN-12 GTIN-13 and GTIN-14
GS1_DATABAR_STACKED_OMNID
IRECTIONAL - Barcode used for any
of GTIN-8 GTIN-12 GTIN-13 and
GTIN-14
GS1_DATABAR_STACKED –
Barcode used for any of GTIN-8
GTIN-12 GTIN-13 and GTIN-14
GS1_DATABAR_TRUNCATED -
Barcode used for any of GTIN-8
GTIN-12 GTIN-13 and GTIN-14
GS1_DATABAR_EXPANDED -
Barcode used for any of GTIN-8
GTIN-12 GTIN-13 and GTIN-14
together with additional information
using GS1 128 standards
GS1_DATABAR_EXPANDED
STACKED - Barcode used for any of
GTIN-8 GTIN-12 GTIN-13 and GTIN-
14 together with additional
information using GS1 128 standard
GS1_DATABAR_LIMITED - Barcode
used for any of GTIN-8 GTIN-12
GTIN-13 and GTIN-14
MAL 0..1 Expiration date type A code specifying the type of GS1
0571 marked on expiration date of the product One of the codes:
package, code marked on the product. “BEST_BEFORE_DATE” or
“EXPIRY_DATE”

MAL 0..1 Package/Product Indicate if the product/package GS1


0572 Marked With Batch is marked with a batch number. Boolean true/false (true = marked
number Indicator with batch number)
MAL 0..1 Package marked The indication of whether there GS1
0573 with Retail price is a retail price of the product – Boolean true/false (true = marked
Indicator physically on or attached to the with retail price)
package
MAL 0..1 Package Marked Indicates if the package is GS1
0574 With Ingredients marked with ingredients. Boolean true/false (true = marked
Indicator with ingredients)
MAL 0..1 Package Marked Indicates if the package is GS1
0575 With Net Content marked with net content.

Date 2008-11-10, Issue #2 UN/CEFACT Page 63 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
Indicator Boolean true/false (true = marked
with net content)
MAL 0..1 Package Marked Indicates if the package is Boolean true/false (true = marked as
0576 Returnable marked as returnable. returnable)
Indicator
MAL 0..1 Retail price Marked A retail price of the product as GS1
0577 on Package marked on the package.

MAL 0..* Offer Text marked A text about an offer marked on GS1
0578 on package, text the package.
MAL 0..n Package Marks The code (s) marked on GS1
0579 containment Code package stating whether or not - code list
the product contains or is free
from a specific substance. FREE_FROM_EGG Marks if the
product is free from egg.
FREE_FROM_FISH The item is
physically marked as being free from
fish, as approved by the appropriate
authority of the target market.
FREE_FROM_GLUTEN Marks if the
product is free from gluten.
FREE_FROM_LACTOSE Indicates if
the amount of lactose is reduced.
FREE_FROM_LATEX The item is
physically marked being free from
Latex (rubber) as approved by the
appropriate authority of the target
market.
FREE_FROM_LEGUME_PROTEIN
The item is physically marked as
being free from legume protein, as
approved by the appropriate authority
of the target market.
FREE_FROM_MILK The item is
physically marked as being free from
milk and any of its derivates, as
approved by the appropriate authority
of the target market.
FREE_FROM_MILK_PROTEIN Free
from milk protein.
FREE_FROM_NATURAL_GLUTEN
The item is physically marked as
being naturally free from gluten and
not extracted as part of the
manufacturing process, as approved
by the appropriate authority of the
target market.
FREE_FROM_PEANUTS Marks if the
product is free from peanuts.
FREE_FROM_PROTEIN The item is
physically marked as being free from
protein, as approved by the
appropriate authority of the target
market.
FREE_FROM_PVC The item is

Date 2008-11-10, Issue #2 UN/CEFACT Page 64 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
physically marked as being free from
PVC (Polyvinyl chloride), as approved
by the appropriate authority of the
target market.
FREE_FROM_SOYA Free from soya.
FREE_FROM_SUGAR Marks if the
product is free from sugar.
REDUCED_LACTOSE Indicates if
the amount of lactose is reduced.
REDUCED_PROTEIN The item is
physically marked as containing a low
level of protein as approved by the
appropriate authority of the target
market.
WITHOUT_ADDED_SUGAR The
item is physically marked that no
sugar has been added when
manufacturing the product but it still
can contain sugars that are naturally
part of the ingredients, as approved
by the appropriate authority of the
target market.
WITHOUT_ADDED_SWEETENER
The item is physically marked that no
sweetener has been added when
manufacturing the product as
approved by the appropriate authority
of the target market
MAL 0..n Package Marks The code (s) marked on the GS1
0580 With Diet Allergen package indicating dietary or Can apply to cosmetics, food, clothes
Code allergen information. and more
code list:
APPROVED_BY_ASTHMA_AND_AL
LERGY_ASSOC Definitions made by
the asthma and allergist association.
APPROVED_FOR_TUBE_FEEDING
The item is physically marked that it is
approved for tube feeding by the
appropriate authority of the target
market.
CONTAINS_LATEX The item is
physically marked as containing Latex
(rubber).
CONTAINS_PVC The item is
physically marked as containing PVC
(Polyvinyl chloride). Phthalate content
is unspecified.
CONTAINS_PVC_WITH_PHTHALAT
ES The item is physically marked as
containing PVC (Polyvinyl chloride)
with phthalates.
CONTAINS_PVC_WITHOUT_PHTH
ALATES The item is physically
marked as containing PVC (Polyvinyl

Date 2008-11-10, Issue #2 UN/CEFACT Page 65 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
chloride) without phthalates.
DIET_PRODUCT_450_800_KCAL_P
ER_DAY The item is physically
marked that it is approved for a 450-
800 kilocalorie/day diet by the
appropriate authority of the target
market.
DIET_PRODUCT_800_1200_KCAL_
PER_DAY The item is physically
marked that it is approved for a 800-
1200 kilocalorie/day diet by the
appropriate authority of the target
market.
LACTASE_ENZYME The item is
physically marked that it is approved
as lactase enzyme by the appropriate
authority of the target market.
LOW_ON_PHENYLALANINE The
item is physically marked as
containing a low level of
phenylalanine as approved by the
appropriate authority of the target
market.
LOW_ON_SUGAR The item is
physically marked as containing a low
level of sugar as approved by the
appropriate authority of the target
market.
MOTHERS_MILK_SUBSTITUTE The
item is physically marked that it is
approved as substitute mother's milk
the appropriate authority of the target
market.
NUTRITION_SUPPLEMENT The
item is physically marked that it is
approved as nutrition supplement by
the appropriate authority of the target
market.
NYCKELHAL_MARK Lean product.
MAL 0..n Package Marked Code of which ethical trading GS1
0581 With Ethical Code marks that are on the package. code list:
FAIR_TRADE_MARK Definition that
child labor is not used in the sup-ply
chain, and other definitions
considered as ethical by proper
authorities.
MAL 0..n Package Marked Code of which environmental GS1
0582 With Environment marks that are on trade item code list:
Code package.
EU_ECO_LABEL The item is
physically marked with the European
Union Eco label a European
environmental initiative supported by
the European Commission.
FALKEN N/A

Date 2008-11-10, Issue #2 UN/CEFACT Page 66 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
FOREST_STEWARDSHIP_COUNCI
L_LABEL The item is physically
marked with the Forest Stewardship
Council label.
GMO_MARKED The item is
physically marked as of genetically
modified origin.
GREEN_DOT N/A
KRAV_MARK N/A
MARINE_STEWARDSHIP_COUNCIL
_LABEL The item is physically
marked with the Marine Stewardship
Council label.
RAINFOREST_ALLIANCE The item
is physically marked with the
Rainforest Alliance Certified symbol.
SVANEN N/A
SWEDISH_SEAL_OF_QUALITY The
item is physically marked with the
Swedish Seal of Quality label which
intends to guarantee the responsibility
for the environment of the product.

1.9.1.22.Logistic Unit Information (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
LUI
LUI 0..1 Logistic unit The code specifying the GS1
0590 package type code package type of the logistic unit. Codes:
UN/ECE recommendation 21

LUI 0..1 Quantity of product The quantity of product GS1


0591 per logistic unit contained in the logistic unit
LUI 0..1 Quantity Of Layers The quantity of layers for the GS1
0592 of the logistic unit logistic unit
LUI 0..1 Quantity Of Product The quantity of products GS1
0593 Per Layer of the contained on a single layer of
logistic unit the logistic unit.

1.9.1.23.Package Information (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PGI
PGI 0..1 Package type code The code identifying the type of GS1
0600 package Code list:
UN/ECE recommendation 21

Date 2008-11-10, Issue #2 UN/CEFACT Page 67 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PGI 0..1 Indicator The package of the product is GS1
0601 Returnable returnable. This is a yes/no Boolean true/false (true = package is
package/asset (Boolean) where yes equals returnable)
package can be returned.
Attribute applies to returnable
package with or without deposit.
PGI 0..1 Returnable The first date that the deposit GS1
0602 package/asset value of the returnable
Deposit value start package/asset is valid.
date
PGI 0..1 Returnable The last date that the deposit
0603 package/asset value of the returnable
Deposit value end package/asset is valid.
date
PGI 0..1 Returnable The monetary amount of the
0604 package/asset deposit for the individual
deposit amount returnable asset
PGI 0..1 Returnable The code specifying the GS1
0605 package/asset returnable package/asset
deposit code deposit..
PGI 0..1 Number of items The number of items that are GS1
0606 per width packaged beside each other in
the package in the width
direction (e.g. on the shelf side
facing the consumer).
PGI 0..1 Quantity Of Number of packages in one GS1
0607 products (Trade layer in the product (trade item).
Items) Contained In Required if the product (trade
A Complete Layer item) is a pallet.
PGI 0..* Returnable The coded or textual description GS1
0608 package/asset of the returnable package/asset
terms and terms and conditions, e.g.
conditions rented, exchangeable,
returnable asset against
deposit).
PGI 0..n Marks and labels The marks and labels provided GS1
0609 on the package
PGI 0..1 Packaging Information about the packaging
0610 information for the package.

1.9.1.24.Packaging Information (Package information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PKI
PKI 0..* Recyclable scheme The textual description of the GS1
0611 (s) for the scheme(s) under which the
packaging, text packaging is recyclable.

Date 2008-11-10, Issue #2 UN/CEFACT Page 68 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PKI 0..n Recyclable type The code specifying the
0612 recyclable type for the
packaging marked on the
product.
PKI 0..n Packaging material Information about the material GS1
0613 composition of the packaging

1.9.1.25.Packaging Material (Packaging information)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PKM
PKM 1..1 Packaging Material The code detailing the package GS1
0620 code material for the packaging. Code list:
Coloured glass
Plain glass
Aluminium
Thermoplastics
Polymers
Paper or cartoonboard
Corrugated board
Metal
Wood
PKM 0..1 Packaging Material A code identifying the agency GS1
0621 Code List that is maintaining packaging The agency or agencies controlling
Maintenance material codes. the
Agency Text
packaging code lists (for each
country).
Code list not available yet.
PKM 0..1 Packaging Material A percentage of the specified GS1
0622 percentage material in the packaging.

PKM 0..1 Packaging Material A weight of the specified GS1


0623 Weight material in the packaging

PKM 0..* Packaging Material The textual description of the GS1


0624 description packaging material.
PKM 0..n Property A technical property of the
0625 material from which the
packaging is composed.

1.9.1.26.Product Material (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PML
PML 1..1 Product Material The code detailing the material GS1
0630 code within the product.

Date 2008-11-10, Issue #2 UN/CEFACT Page 69 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PML 0..1 Product Material A code identifying the agency GS1
0631 Agency Code that is maintaining product
material codes.
PML 0..1 Product Material A percentage of the material in GS1
0632 percentage the product.
PML 0..n Product Material A measured quantity of material GS1
0633 Quantity in the product
PML 0..* Product Material The textual description of the GS1
0634 description product material.

PML 0..n Property A technical property of the


0635 material from which the product
is composed.

1.9.1.27.Product Unit (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PRU
PRU 0..1 Product Unit An identity for the product UBL
0650 Individual unit (individual item) Example of Use case:
Identification
could be a SGTIN (GS1 Serialised
GTIN) which also can be contained in
a EPC RFID
PRU 0..1 Manufacture The date (and time) of UBL
0651 DateTime manufacture of the Item
Instance e.g manufacture date
for a used car (second hand).
PRU 0..1 Registration The registration identifier of the UBL
0653 Identification Item Instance.

PRU 0..1 Product Instance The serial number of the product UBL
0654 Serial Number instance.

PRU 0..1 Production Batch An identification of the UBL


0655 Identification production batch of the product.
Example of use case:
Facilitate selective recalls of a
product if necessary.

1.9.1.28.Product Class (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PCL
PCL 0..1 International The ISO-specified data element ISO/IEC 6523-1 - Identification of
0671 Codification used to uniquely identify a organization identification schemes
Designation, ICD registration scheme. (ISO/IEC Code list for ICD from ISO maintained
6523-1) by UK BSI, British Standard Institute

Date 2008-11-10, Issue #2 UN/CEFACT Page 70 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PCL 0..1 Organisation The identifier assigned to an
0672 Identification, OI organization within a registration
scheme, and unique within that
scheme.
PCL 0..1 Organisation The identifier allocated to a
0673 Particular particular department, service or
Department other entity within an
Identification, OPI organization
PCL 0..1 Source of The data element used to
0674 Organisation specify the source for the
Particular organization part identifier.
Identification, OPIS (ISO/IEC 6523-1)
PCL 0..1 Number of ISO For referencing standards, here
0675 standard Reference the standard number will be
given (e.g. 61360 for the IEC
61360)
PCL 0..1 ISO standard Part For referencing standards, here
0676 Reference the part of the standard will be
given (e.g. 2 for the Part 2 of
IEC 61360)
PCL 0..1 ISO standard Edition of the standard
0677 Edition Reference
PCL 1 Class Code Gives the identification of the
0678 class in the context of the
classification / ontology
PCL 0..1 Class Version A reference to the version of the
0679 Reference class
PCL 0..n Property Used for further specification of
0688 product class for the product i.e.
GS1 GPC

1.9.1.29.Property (Packaging Material, Product, Product Material and Product Class)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PTY
PTY 0..1 International The ISO-specified data element
0700 Codification used to uniquely identify a
Designation, ICD registration scheme. (ISO/IEC
6523-1)
PTY 0..1 Organisation The identifier assigned to an
0701 Identification, OI organization within a registration
scheme, and unique within that
scheme.
PTY 0..1 Organisation The identifier allocated to a
0702 Particular particular department, service or
Department other entity within an
Identification, OPI organization

Date 2008-11-10, Issue #2 UN/CEFACT Page 71 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PTY 0..1 Source of The data element used to
0703 Organisation specify the source for the
Particular organization part identifier.
Identification, OPIS (ISO/IEC 6523-1)
PTY 0..1 Number of ISO For referencing standards, here
0704 standard, the standard number will be
Reference given (e.g. 61360 for the IEC
61360)
PTY 0..1 ISO standard Part For referencing standards, here
0705 Reference the part of the standard will be
given (e.g. 2 for the Part 2 of
IEC 61360)
PTY 0..1 ISO standard Edition of the ISO standard
0706 Edition Reference
PTY 0..1 Property Code Coded representation of the
0707 property
PTY 0..1 Further The indicator indicating that the Indicator:
0721 Categorization product is further categorized. True – Further categorization
Indicator

For further categorisation of product


classifications.
Rational is to specialise further
attributes according to a specific
classification system i.e. GS1 Global
Product Classification system.
Restrictions:
Only to be used in relation to Product
Class.
PTY 0..1 Version of class The version of the class
0708
PTY 1..1 Technical property The code specifying the type of
0709 Type, code technical property
PTY 0..1 Technical property The textual description of the
0710 Type, Text type of property.
PTY 0..* Property Value Text The value of the property
0711 expressed as a textual
description.
PTY 0..n Property Value The value of the property
0712 Code expressed as a code
PTY 0..n Property Value The value of the property
0713 Indicator expressed as an indicator.
PTY 0..n Property Value The value of the property
0714 Date Time expressed as a date time.
PTY 0..n Property Value The value of the property
0715 Binary expressed in a binary format.
PTY 0..* Property Relation A textual description of or other
0716 Information Text information on property
relations.

Date 2008-11-10, Issue #2 UN/CEFACT Page 72 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
PTY 0..n Property definition The reference to a document,
0717 Reference e.g. an ontology or standard, in
which the property has been
defined
PTY 0..1 Product Class The product class that forms the
0718 context in which the property is
defined.
PTY 0..* Property Relation Related property. E.g. a Voltage
0719 at a certain Temperature.
PTY 0..n Property Value The value of the property
0720 Quantity expressed as a quantity
(measurement) (including unit of
measure, UN/ECE rec 20)

1.9.1.30.Product Specification Information Reference (Product)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
PIR
PIR 1..1 Product An associative reference to a UBL – Item Specification Document
0730 Specification document providing product Reference in Item
Document specification information
Reference
Qualified association to Document
Reference

Consider to be used for referring to


ontologies
PIR 1..1 Code for format Code list:
0731 for document - excel
providing product
specification - Pdf
information - ontoML

1.9.1.31.Trade Item Delivery Lead Time (Trade Agreement)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
DLT
DLT 1..1 Lead time The time taken from the time of GS1
0740 order to the time of delivery Can be dependent on quantity or
location or both.

DLT 0..1 Minimum Order Minimum order quantity for a GS1


0741 quantity specific lead time

DLT 0..1 Maximum Order Maximum order quantity for a GS1


0742 quantity specific lead time

Date 2008-11-10, Issue #2 UN/CEFACT Page 73 of 75


Business Requirements Specification Catalogue

UID Crd Short Name Business Requirement Rationale / Example / Mapping


Notes
DLT 0..1 Delivery Location delivery locations or areas for
0743 items
DLT 0..1 Delivery Region delivery regions for items
0744

1.9.1.32.Signature (All documents)


UID Crd Short Name Business Requirement Rationale / Example / Mapping
Notes
SIG
SIG 1..1 Signature The identifier for the signature NES UBL
0770 Identification
SIG 0..* Notification, text A notification about the NES UBL
0771 signature or the circumstances
where the signature has been
used in clear text
SIG 0..1 Validation Date Specifies the date when the NES UBL
0772 signature was approved
SIG 0..1 Validation Time Specifies the time when the NES UBL
0773 signature was approved

SIG 0..1 Validator Identifier Identifies the organization, NES UBL


0774 person, service or server that
has validated the signature
SIG 0..1 Canonicalization The mathematical logic method NES UBL
0775 Method, code used by the Signature
SIG 0..1 Signature The method of signature NES UBL
0776 Method, code
SIG 1..1 Signatory Party An association to the signing NES UBL
0777 Party.
SIG 0..1 Digital Signature Refers to the actual encoded NES UBL
0778 Attachment signature (e.g., in XMLDSIG
format).
SIG 0..1 Document A reference to the actual NES UBL
0779 Reference document that the signature
applies to. For evidentiary
purposes, this may be the
document image that the
signatory party saw when
applying their signature

Business Rules

Use case examples


Use case 1
Price information exemplifying use of bracket price, location and price comparison

Date 2008-11-10, Issue #2 UN/CEFACT Page 74 of 75


Business Requirements Specification Catalogue

Price Information may be given 0..n times per each product.

Product Id (GTIN) 07365560013130


Price Price Price
Information Information 2 Information 3
1
Price amount 0..1 245 220 198
Price type 0..1 Contract price, net Contract price, net Contract price, net
price price price

Minimu Maximu 0..1 1 10 11 20 21 30


m- m-
Bracket Bracket
Price Price
Quantit Quantity
y Range
Range
Price Validity 0..n 7300000000000 7300000000000 7300000000000

Location 4300000000000 4300000000000 4300000000000

4500000000000 4500000000000 4500000000000

5000000000000 5000000000000 5000000000000

Price Comparison 0..1


Comparison Price 24.50 22 19.80
Amount
Price Unit of 10 LTR 10 LTR 10 LTR
Comparis measurem
on ent
Quantity
Price Comparison READY_TO_DRI READY_TO_DRI READY_TO_DRI
NK NK NK
Type Code

Definition of Terms
Term Definition Source

Date 2008-11-10, Issue #2 UN/CEFACT Page 75 of 75