TBG17 BP_CC – Harmonization Team

Document Sample
TBG17 BP_CC – Harmonization Team Powered By Docstoc
					UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

GENERAL UN/CEFACT/TBG17/N004 20 May 2008

TBG17 CCL (Core Component Library) Submission Guidelines and Procedures

20 May2008 Version 3.01

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 1 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

1. Status of This Document This document contains information to guide in the creation of submissions of core components to the UN/CEFACT Core Component Library. Distribution of this document is unlimited. This version: TBG17 CCL (Core Component Library) – Submission Guidelines and Procedures, Version 3.01 of 20 May 2008 Previous version: TBG17 BP&CC – Harmonization Team Submission Guidelines and Procedures, Version 2.00 of 17 August 2006

2. Submission Guidelines and Procedures Administration The leaders and editors express gratitude to the significant number of participants who contributed to the successful completion of this document. Project Team Leader: Lead Editor: Mary Kay Blantz, USA Hisanao Sugamata, Japan

Editing Team Members: Thomas Lyons, USA Patricia Toufar, USA Nigel Wooden, UK Marion Royal, USA Bernd Boesler, Germany Contributors: Chris Hassler, USA Paula Heilig, USA Andrew M Schoka, USA Sue Probert, UK Sylvia Webb, USA Coen Janssen, Nederland Stig Korsgaard, Denmark James Whittle, UK Rob Exell, UK

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 2 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

3. Table of Contents
1. Status of This Document ........................................................................................................................ 2 2. Submission Guidelines and Procedures Administration....................................................................... 2 3. Table of Contents.................................................................................................................................... 3 4. Introduction ............................................................................................................................................ 4 4. Introduction ............................................................................................................................................ 4 4.1 General .............................................................................................................................................. 4 4.2 Scope and Focus................................................................................................................................ 4 4.3 Structure of the Document............................................................................................................... 5 4.4 Related Documents ........................................................................................................................... 5 5. Working Process and Methodology ...................................................................................................... 5 5.1 Methods of Submission .................................................................................................................... 5 5.2 Working Process Overview.............................................................................................................. 6 5.3 Harmonization Process .................................................................................................................... 7 5.3.1 General ....................................................................................................................................... 7 5.3.2 Getting Started........................................................................................................................... 8 5.3.3 CC Harmonization .................................................................................................................... 9 5.3.4 Editing BIEs by Submitter and Editor Review ..................................................................... 11 5.3.5 BIE Harmonization ................................................................................................................. 11 5.3.6 Quality Assurance.................................................................................................................... 13 5.3.7 ICG Submission ....................................................................................................................... 13 6 Change Request to CCL........................................................................................................................ 13 7 Harmonization Rules and Guidelines .................................................................................................. 14 8 CCL Administration.............................................................................................................................. 16 8.1 CCL Stages...................................................................................................................................... 16 8.2 Harmonization CCL....................................................................................................................... 17 8.3 Posted Draft CCL ........................................................................................................................... 17 8.4 Beta CCL ......................................................................................................................................... 17 8.5 Validation ........................................................................................................................................ 18 8.6 Published CCL................................................................................................................................ 18 Reference 1. Submission Template ......................................................................................................... 19 Reference 2. Change Request Form for CCL ........................................................................................ 27 Reference 3. Submission Assessment Checklist ..................................................................................... 28 Reference 4. Definition Boilerplate ......................................................................................................... 28 Reference 5. Controlled Vocabulary ....................................................................................................... 28 TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 3 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

4. Introduction 4.1 General The purpose of TBG17 is to be responsible for consistency and harmonization of business process models and core components across business domains and sectors, contributing to a concise and well-defined glossary of business terms, business data semantic definitions, and structuring of data exchanges. This TBG17 CCL (Core Component Library)-Submission Guidelines and Procedures builds upon the Core Components Technical Specification, Version 2.01, with the goal of resolving many of the well-known problems caused by the lack of information interoperability between applications in the e-business arena. Traditionally, standards for the exchange of business data have been focused on static message definitions that have not enabled a sufficient degree of interoperability or flexibility. A more flexible and interoperable way of standardizing Business Semantics is required. The UN/CEFACT (United Nations Centre for Trade Facilitation and Electronic Business) Core Component solution presents a methodology for developing a common set of semantic building blocks that represent the general types of business data in use today and provides for the creation of new business vocabularies and restructuring of existing business vocabularies. While the Core Component Technical Specification describes, in detail, the process by which core components are discovered and created, there is another necessary step required to ensure the interoperability between horizontal businesses as well as vertical business. This document describes the process by which business domain groups may ensure the common taxonomy used in one business domain may be interoperable. The keywords MUST, MUST NOT, SHALL, SHALL NOT, SHOULD, SHOULD NOT, and MAY, when they appear in this document, are to be interpreted as described in Internet Engineering Task Force (IETF) Request For Comments (RFC) 2119.

4.2 Scope and Focus The Core Components user community consists of business people, business document modelers and business data modelers, business process modelers, and application developers of different organizations that require interoperability of business information. This interoperability covers both interactive and batch exchanges of
TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 4 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

business data between applications through the use of Internet and Web based information exchanges as well as traditional Electronic Data Interchange (EDI) systems. This guideline supports the standards development work of business analysts, business users and information technology specialists supplying the content of and implementing applications that will employ the UN/CEFACT Core Component Library (CCL). The Core Component Library will be stored in a UN/CEFACT repository and identified in an ebXML compliant registry.

4.3 Structure of the Document This document details each of the steps necessary for a valid submission to TBG17. For detailed information, it is strongly recommended that the Submitters consult the Core Component Technical Specification Version 2.01.

4.4 Related Documents The following documents were used as input to the development of this document:     Core Components Technical Specification, version 2.01; UN/CEFACT/TBG17/N002 TBG17 Terms of Reference; UN/CEFACT Forum/TBG17/N003 TBG17 Procedures; IETF Request For Comments (RFC) 2119.

5. Working Process and Methodology 5.1 Methods of Submission There are three approved methods of submission to TBG17 of a set of BIEs (Business Information Entities), CCs (Core Components) and qDTs (qualified Data Types.) for harmonization. 1. Normal: The normal submission is relevant to a certain scope of the business process, the collaboration, or the transaction. Typically a normal submission is supported by a BRS (Business Requirement Specification.) The normal submission includes both CCs and BIEs, and possibly qDTs. 2. Bulk: The bulk submission is possible when a specific sector submits a set of candidate core components that it has extracted from a published repository of their business processes. A bulk submission is supported by the documents describing the scope of the domain and the related information model. It MAY be submitted without BIEs or qDTs.
TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 5 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

3. Change request to CCL: The change request submission is a set of change requests to existing BIEs or CCs in the latest version of CCL. The change request SHOULD include specific business justifications for the change. This submission process is described in Chapter 6 (Change request to CCL). 5.2 Working Process Overview TBG17 harmonizes each set of CCs, BIEs and qDTs relevant to a certain scope of the business process, the collaboration or the transaction (Normal submission) or extracted from an existing repository of a specific sector covering its business processes (Bulk submission). TBG17 harmonizes each set of CCs, BIEs and qDTs among domains to ensure that the harmonized set of CCs, BIEs and qDTs may be used across different business process domains. Using this guideline, the Submitter prepares the documentation which supports his/her business needs. TBG17 starts with the harmonization process (CC Harmonization) for the referenced CCs on which the submitted BIEs are based. Once the CCs have been harmonized, the harmonization process continues with the harmonization of submitted BIEs and qDTs. Any decision making in the harmonization process is based on consensus within the participants of TBG17 at a face-to-face meeting or a TBG17 teleconference. In the absence of consensus, then, and only then, shall a vote be taken and a decision made by a simple majority of the TBG17 voting members quorum. The final deliverable of the harmonization process is a set of CCs, BIEs and qDTs which conform to CCTS and is harmonized with CCs, BIEs and qDTs published in the latest CCL.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 6 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

Figure 5.1 shows the harmonization process for a Normal Type of Submission.
The details of the process are specified in the following sections.

Submission of BRS,RSM or Spreadsheet +Class Diagram or Data Model Edit against Checklist Accepted and Registered in Queue CC Harmonization (See Section 5.3.3) Edit BIEs by Submitter based on the harmonized CCs Review by Editor
No Any BIEs for Harmonization ? ( Editor Recommended )

BIE Harmonization (See Section 5.3.5) QA
Any BIEs for Re-Harmonization ? ( QA Recommended ) No Yes

Prepare ICG Submission
Figure 5.1 Harmonization Process Overview 5.3 Harmonization Process 5.3.1 General The goal of TBG17 is to build a harmonized CCL that facilitates international trade and commerce. The specific priorities may be determined by UN/CEFACT leadership.
TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 7 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

For each submission, a Provisional Team is formed to harmonize the submission. This team is comprised of the Submitter(s), an Editor, a Quality Assurance member and any interested TBG17 members. There are two phases in the TBG17 Harmonization Process, (1) CC Harmonization and (2) BIE Harmonization. 5.3.2 Getting Started (1) Preparation of Submission A Submitter is a submitting organization of a TBG Working Group, a Cross Domain Project Team of TBG members, or an organization recognized as a TBG17 liaison member (see TBG17 Terms of Reference and TBG Procedure). A Submitter SHOULD prepare the documents specifying the business process, the collaboration or the transaction which requires CCs, BIEs and qDTs. These documents SHOULD conform to the BRS specification (CEFACT/ICG/005) and the RSM specification (CEFACT/ICG/006), if the submission is being made by a TBG or a joint project of TBGs. If a Submitter is an organization recognized as a TBG17 liaison member, the organization MUST submit an information model. For the bulk submission, a Submitter MUST make available the published repository related to the submission. The Submitter SHALL prepare the documents describing the scope of the domain which the submission covers and an information model such as the class diagram for the data model. The Submitter MAY use the describing methodology of Business Domain View in UMM. Furthermore, the Submitter is encouraged to prepare the documents describing the business process. The submitted CCs, BIEs and qDTs MUST be specified on the spreadsheet form in accordance with the TBG17 Submission Template (see Reference 1) or in a zef (native GEFEG.FX format) format which can be exported to create the TBG17 Submission Template. This spreadsheet (or zef file) with any relevant documents which describe the business domain and the business process must be submitted to the TBG17 Chair.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 8 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

(2) Editor Review When the TBG17 Chair receives a submission, it is forwarded to the Lead Editor. The Lead Editor assigns an Editor to this submission. The Editor checks whether there are sufficient documents for submission (TBG17 Spreadsheet (or zef file) and the relevant documents) and that the submission is compliant with CCTS and follows the guidelines in this document. The Editor checks the submission against the Submission Assessment Checklist (see Reference 3). The Editor MAY perform this assessment with the Submitter in person or virtually. The Editor SHOULD return the submission to the Submitter for correction if there are any errors. The Editor MAY work with the Submitter to address changes. When the Submitter has made any necessary corrections, the submission is returned to the Editor. Once the Editor ascertains that the submission is ready for harmonization, the Editor notifies the Submitter and TBG17 Chair of the status of the submission and posts the accepted submission on the appropriate web site. After the assessment by the Editor, the submitted spreadsheet is accepted and registered in the TBG17 Harmonization (Working) CCL as a candidate for harmonization. 5.3.3 CC Harmonization 5.3.3.1 General The first step of the harmonization is CC Harmonization. The CC Harmonization is processed by the Provisional Team including the Submitter(s), the Editor, a Quality Assurance (QA) member, and any interested TBG17 members. The Provisional Team assesses the submission and makes recommendations for changes, approvals and withdrawals. The Provisional Team refers to CCTS, the Submission Assessment Checklist, the Definition Boilerplate and the Controlled Vocabulary during harmonization. TBG17 reviews the results of the harmonization by the Provisional Team. 5.3.3.2 Normal Submission The objective of the CC Harmonization for a Normal Submission is to harmonize all the CCs referenced by the BIEs within the submission.
TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 9 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

Figure 5.2 shows the work flow of CC Harmonization for a Normal Submission.

BRS

Assess the Info. Model

Business Process Model
RSM Information Model Structure

Characterize Core Concept
NO With New/Chg CC Requirement ? YES

All the ACC

Harmonize BCCs Harmonize ASCCs Harmonize ACC
Define the business concept

Checklist

CV

CCTS

Figure 5.2 CC Harmonization (Normal Submission) (1) Selecting Core Component for Harmonization (1-1) Understanding BRS, RSM The Submitter presents the model (BRS, RSM or other forms) to TBG17 to aid in the understanding of the business needs and the outline of the information model on which the submitted BIEs are based. (1-2) Starting CC Harmonization The CC Harmonization includes those Core Components from which all the submitted BIEs are derived.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 10 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

(2) CC Harmonization Process (2-1) The BCCs aggregated to the ACC SHALL be harmonized first. The ASCCs aggregated to the ACC SHALL be harmonized next, after the associated ACCs are harmonized. The target ACC SHALL be harmonized after all the BCCs and all the ASCCs are successfully harmonized. 5.3.3.3 Bulk Submission (1) Target Core Component (1-1) Understanding Business Domain The Submitter presents the documents describing the scope of the domain which the submission covers. (2) CC Harmonization Process (2-1) The BCCs aggregated to the ACC SHALL be harmonized first. The ASCCs aggregated to the ACC SHALL be harmonized next, after the associated ACCs are harmonized. The target ACC SHALL be harmonized after all the BCCs and all the ASCCs have been successfully harmonized. 5.3.4 Editing BIEs by Submitter and Editor Review After the CC Harmonization, the set of the harmonized CCs is sent to the Submitter for the editing of the BIEs to align them to the harmonized CCs. The Submitter makes the corrections to the BIEs and qDTs based on the harmonized CCs. The Editor reviews all the BIEs and qDTs corrected by the Submitter. 5.3.5 BIE Harmonization The ACC on which the ABIE is based MUST be in the CCL, be approved in another submission or have been harmonized during the harmonization process for this submission. The Provisional Team assesses the submission and makes recommendations for changes, approvals and withdrawals.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 11 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

Figure 5.3 shows the work flow of BIE Harmonization.
BRS

Business Process Context
RSM

All the ABIE

Characterize ABIE Concept
YES NO Same ABIE in CCL ? NO With New/Chg ABIE Requirement ? YES Base ACC/BCC/ASCC is in CCL Or Harmonized ? YES

Information Model Structure

CC Harmonization

NO

Harmonize BBIEs Harmonize ASBIEs Harmonize ABIE

Define the business concept

Checklist

CV

CCTS

Figure 5.3 BIE Harmonization The BBIEs aggregated to the ABIE SHALL be harmonized first. The BCC on which the BBIE is based MUST be in the CCL or approved in another submission or already harmonized during the harmonization process for this submission. The ASBIEs aggregated to the ABIE SHALL be harmonized next. The ASCC on which the ASBIE is based MUST be in the CCL or approved in another submission or already harmonized during the harmonization process for this submission.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 12 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

The target ABIE SHALL be harmonized after all the BBIEs and all the ASBIEs have been successfully harmonized. 5.3.6 Quality Assurance After the review by the Editor and by TBG17, the set of approved CCs, BIEs and qDTs are sent to the QA Team for quality assurance. The TBG17 QA Team assesses the spreadsheet edited using the Submission Assessment Checklist (see Reference 3) and Definition Boilerplate (see Reference 4). If the QA Team finds any errors and/or any questionable items in the edited set of CCs, BIEs and qDTs, those items are either corrected with the approval of the Submitter or noted for review by TBG17. 5.3.7 ICG Submission The chair of TBG17 sends the chair of ICG the spreadsheet of the set of harmonized CCs, BIEs and qDTs for auditing. 6 Change Request to CCL A Submitter may submit a set of change requests to the existing ABIE or ACC in the latest version of CCL based on specific business needs. A change request for CC can be: Change a definition, a business term and/or a usage rule of an ACC; Change a name, a definition, an occurrence, a business term and/or a usage rule of a BCC; Change a name, a definition, an occurrence, a business term and/or a usage rule of an ASCC; Add a BCC to an existing ACC; Add an ASCC to an existing ACC; Delete an existing ACC, BCC or ASCC.

The impact of the change (such as a name change, a definition change or deletion) SHALL be assessed during the harmonization. A Submitter SHALL follow the process defined for the normal submission (see Section 5) for a submission of a new ACC.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 13 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

A change request for BIE can be: Change a definition, a business term, contexts and/or a usage rule of an ABIE; Change a name, a definition, an occurrence, a data type qualifier, a business term, contexts and/or a usage rule of a BBIE; Change a name, a definition, an occurrence, a business term, contexts and/or a usage rule of an ASBIE; Add a BBIE to an existing ABIE; Add an ASBIE to an existing ABIE; Delete an existing ABIE, BBIE or ASBIE.

The impact of the change (such as a name change, a definition change or deletion) SHALL be assessed during the harmonization. A Submitter SHALL follow the process defined for the normal submission (see Section 5) for a submission of a new ABIE. A Submitter of a change request is a TBG or a joint project of TBGs, an organization recognized as a TBG17 liaison member (see TBG17 Terms of Reference). A Submitter sends the change request form (see Reference 2) specifying the business needs along with the TBG17 Spreadsheet (see Reference 1) or in a zef format which can be exported to create the TBG17 Submission Template to the TBG17 Chair. A Submitter is encouraged to attach the class diagram explaining the information model relevant to the change request. 7 Harmonization Rules and Guidelines TBG17 Harmonization SHALL follow all of the rules in the current version of the CCTS. In addition to the rules in the CCTS, TBG17 has adopted the following Rules and Guidelines which TBG17 has learned through the experience of Harmonization. Further Rules and Guidelines may be added as future Harmonization experience dictates.  Qualifiers for the Object Class of ABIEs are optional when the content structure of the ABIE is identical to the content structure of the underlying ACC.  Standalone BCCs and BBIEs MUST NOT exist outside of ACCs or ABIEs following the CCTS.
TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 14 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

 The submission SHOULD NOT include BCCs which are generic in nature where they are not backed by a business requirement (submission) and where they have no clear business semantics. Based on the business semantic meaning, BCCs SHOULD be named as generic as possible. Note that business domain qualification occurs at the BIE level in context.  The Property Term MUST NOT be identical to either the Representation Term, the Object Class name, or the Associated Object Class name.  The Property Term MUST NOT contain the Representation Term (e.g., Contract. Start. Date and not Contract. Start Date. Date).  TBG17 uses the full set of Representation Terms (RT) including the Primary and Secondary RTs as specified in CCTS v2.01 except „Name‟. „Name‟ MUST NOT be used as a Representation Term for BCCs or BBIEs in the Library.  The Submitter SHOULD set the cardinality of properties within an ACC to be unbounded unless there are very clear business/technical reasons for any restriction.  The Submitter SHOULD refer to and follow as far as possible the TBG17 Definitions Template when preparing submissions.  The Oxford English Dictionary in conjunction with the TBG17 Controlled Vocabulary SHOULD be used as a reference source for meanings of words in definitions and DEN (Dictionary Entry Name) Terms.  The names of the Content Component and the Supplementary Components of DTs SHALL NOT be qualified.  The Representation Term “Quantity” shall be used when the BCC has a concept of “Counting”.

Notes: ・ TBG17 may suggest changes where submitted definitions are not sufficiently clear. ・ TBG17 Submission Template Microsoft Excel (xls) format or zef file format are the two allowed formats for submission to TBG17.

・ Supplementary components are always optional for uDTs. For example, Unit. Code is optional in Quantity Type.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 15 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

8 CCL Administration 8.1 CCL Stages A release of a Core Component Library goes through 4 stages as it goes through the Harmonization process.     Harmonization CCL Posted Draft CCL Beta CCL Published CCL

Core Components SHOULD be versioned, as well as the library. Although the library would be versioned effectively via a published date e.g., D06B, the Core Components will be versioned with version number. The figure 8.1 shows the conceptual relationship among four kinds of CCLs.

Submissions

Harmonization (Working) CCL

Posted Draft CCL

Beta CCL YYx

Validation At ICG

Published CCL YYx

Figure 8.1 Core Component Library Stage

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 16 of 28

UN/CEFACT
United Nations Centre for Trade Facilitation and Electronic Business

8.2 Harmonization CCL The Harmonization CCL is the TBG17 Internal working library posted on the TBG17 website.1 The Harmonization CCL is available to all parties who are involved in the harmonization process upon request. The Harmonization CCL includes all submissions accepted (means technically clean for harmonization, whether or not they have been harmonized.2 8.3 Posted Draft CCL The Posted Draft CCL includes all ACCs and ABIEs approved by TBG17 and may include partial submissions. The Posted Draft CCL is posted on TBG17 website.3 The Posted Draft CCL allows Submitters to understand where their submission stands in the harmonization process. The Posted Draft CCL will hopefully also foster maximizing the reuse of CCs by making accepted constructs visible to new submissions. The Posted Draft CCL SHOULD NOT be used for implementation. 8.4 Beta CCL The Beta CCL includes only those approved components which represent a complete submission. 4 The incomplete submissions remain in the Draft CCL. Each Beta CCL is scheduled to be produced every six months. The Beta CCL is posted on the TBG17 website as Beta CCL YYx, where YY is Year and x is A or B (as A is the first posted and B is the second posted of the year). 5 Implementers may begin testing using the Beta CCL with the understanding that some changes may occur during validation.

1

Implementers may begin testing using the Harmonization CCL with the understanding that some change(s) may occur

during validation. The Harmonization CCL is available from TBG17 representatives of the TBGs and the TBG17 Liaison representatives. 2 In the future it may also mean pre-harmonization QA. 3 TBG17 is currently using https://collab.core.gov. It is expected to improve availability to all Submitters. 4 The complete submission of Harmonized, approved, and QA‟d CCs BIEs and qDTs are posted both in Excel and zef (Gefeg.FX) formats. 5 TBG17 is currently using https://collab.core.gov. It is expected to improve availability to all Submitters.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 17 of 28

8.5 Validation The Beta CCL will be submitted to ICG for validation. The set of contents submitted is frozen for all changes other than adjustments needed to complete validation. The change log SHALL be recorded during the validation. The library remains in Beta status until the validation is finalized. The validation process is expected to be completed within eight weeks. 8.6 Published CCL The CCL validated by ICG will be published by UNECE as CCL YYx, where YY is Year and x is A or B (as A is the first posted and B is the second posted of the year). The Published CCL is recommended for implementation.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 18 of 28

Reference 1. Submission Template In order to help achieve consistent submissions across all business domains, a workbook template has been developed to help ensure this necessary consistency. What follows are guidelines to use when completing the template. The template contains four separate worksheets. The first is for CCs, the second for BIEs, the third is for qDTs, and the fourth worksheet for uDTs. The last worksheet is informational only and MUST NOT be altered. Submission Workbook Overview Core Component Worksheet (CC)
Input Heading ADD/CHG/DEL/WDR Required. Optional/Required This indicates the action to be taken with

regard to the CC. ADD: CHG: DEL: library; WDR: Unique UN Assigned ID ABIE/ BBIE/ ASBIE/ACC/BCC/ASCC/DT/CC/SC Dictionary Entry Name Definition Working comments and instructions Generated based on other columns. Required. Optional. Any comments the Submitter has for TBG17, or TBG17 internal comments during harmonization. Publication comments Optional. Comments that the Submitter or TBG17 want to be included in the published library. Object Class Term Property Term Representation Term Associated Object Class Business Term(s) Usage Rule(s) Required. Required for BCC, ASCC. Required for BCC. Required for ASCC. Optional. Optional. Withdraw a CC from a submission. Add the CC to the library; Change an existing CC; Remove a CC from a previously published

This value is assigned by TBG17 Required.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 19 of 28

Input Heading Sequence Number

Optional/Required Required for BCC, ASCC. Denotes the order of elements within an ACC. Numbering is independent between BCCs and ASCCs in the same ACC.

Occurrence

Required for BCC, ASCC. Min Max Required. Required.

Example(s) BIE/CC/DT Version Ref Library Version

Optional. TBG17 use only. Required. The CCL version on which the submission

is based, and it must be identical for all CRs within a single submission. Submitter Name Required. This indicates from whom the submission

was received. Ref Component UN ID Required for CHG, WDR, DEL Indicates the UN ID

number of the component which is being changed, withdrawn, or deleted. may not exist. Ref Submitter CR ID Unique Submitter CR ID Required for Withdrawal. Required. This is the mechanism by which references In the case of WDR, a UN ID

to your original submission are maintained. CR Status Date CR Status TBG17 Comment TDED TBG17 use only. TBG17 use only. TBG17 use only. Optional. Reference a TDED component number, if applicable.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 20 of 28

Business Information Entities Worksheet (BIE) The tabular layout of the spreadsheet follows:
Input Heading ADD/CHG/DEL/WDR Required. Optional/Required This indicates the action to be taken with

regard to the BIE: ADD: CHG: DEL: library; WDR: Unique UN Assigned ID ABIE/ BBIE/ ASBIE/ACC/BCC/ASCC/DT/CC/SC Dictionary Entry Name Definition Working comments and instructions Withdraw a BIE from a submission. Add the BIE to the library; Change an existing BIE; Remove a BIE from a previously published

This value is assigned by TBG17 Required. (note: CC in input heading is Content Component) Generated based on other columns. Required. Optional. Any comments the Submitter has for TBG17, or TBG17 internal comments during harmonization.

Publication comments

Optional. Comments that the Submitter or TBG17 want to be included in the published library.

Object Class Term Qualifier(s)

Required if there is any restriction whatsoever on the ABIE based on what is available in the ACC.

Object Class Term Property Term Qualifier(s) Property Term Data Type Qualifier(s) Representation Term Qualified Data Type UID Associated Object Class Term Qualifier(s) Associated Object Class Business Term(s) Usage Rule(s)

Required Optional for BBIE, ASBIE. Required for BBIE, ASBIE. Optional for BBIE. Required for BBIE only. Required if qDT is used. Optional for ASBIE. Required for ASBIE. Optional. Optional.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 21 of 28

Input Heading Sequence Number

Optional/Required Required for BBIE, ASBIE. Denotes the order of elements within an ABIE. Numbering is independent between BBIEs and ASBIEs in the same ACC.

Occurrence

Required for BBIE, ASBIE. Min Max Required. Required. Each category has three columns: Value,

Context Categories

Required.

Meaning, and Class. Scheme. Of these, only the Value is currently required. The usage of the other two

columns will be determined by the Context Methodology. Business Process Required for ABIE, BBIE, ASBIE. Product Required for ABIE, BBIE, ASBIE. Industry Required for ABIE, BBIE, ASBIE. Region (Geopolitical) Required for ABIE, BBIE, ASBIE. Official Constraints Required for ABIE, BBIE, ASBIE. Role Required for ABIE, BBIE, ASBIE. Supporting Role Required for ABIE, BBIE, ASBIE. System Constraints Required for ABIE, BBIE, ASBIE. Example(s) BIE/CC/DT Version Ref Library Version Optional. TBG17 use only. Required. The CCL version on which the submission

is based, and it must be identical for all CRs within a single submission. Submitter Name Required. This indicates from whom the submission

was received. TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 22 of 28

Input Heading Ref Component UN ID

Optional/Required Required for CHG, WDR, DEL Indicates the UN ID

number of the component which is being changed, withdrawn, or deleted. may not exist. Ref Submitter CR ID Unique Submitter CR ID Required for Withdrawal. Required. This is the mechanism by which references In the case of WDR, a UN ID

to your original submission are maintained. CR Status Date CR Status TBG17 Comment TDED TBG17 use only. TBG17 use only. TBG17 use only. Optional. Reference a TDED component number, if applicable.

Qualified Data Type Worksheet (qDT) The tabular layout of the spreadsheet follows:
Input Heading ADD/CHG/DEL/WDR Required. the CC: ADD: CHG: DEL: WDR: Unique UN Assigned ID ABIE/ BBIE/ ASBIE/ACC/BCC/ASCC/DT/CC/SC Dictionary Entry Name Definition Working comments and instructions Add the CC to the library; Change an existing CC; Remove a CC from a previously published library; Withdraw a CC from a submission. Optional/Required This indicates the action to be taken with regard to

This value is assigned by TBG17. Required. (note: CC in input heading is Content Component) Generated based on other columns. Required. Optional. Any comments the Submitter has for TBG17, or TBG17 internal comments during harmonization.

Publication comments

Optional. Comments that the Submitter or TBG17 want to be included in the published library.

Data Type Qualifier(s)

Optional for BBIE.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 23 of 28

Input Heading Representation Term Sequence Number Facets Required for BCC.

Optional/Required

Required for SC. Denotes the order of elements within a qDT. Required. Although not each of the facets is required, you

must annotate the ones applicable to your submission. For definitions of these terms, you should reference CCTS. Expression Length Min Length Max Length Enumeration Total Digits Fractional Digits Min Inclusive Max Inclusive Min Exclusive Max Exclusive Expression Type Restriction Value White Space Example(s) BIE/CC/DT Version Ref Library Version Optional. TBG17 use only. Required. The CCL version on which the submission is based,

and it must be identical for all CRs within a single submission. Submitter Name Required. received. Ref Component UN ID Required for CHG, WDR, DEL Indicates the UN ID number This indicates from whom the submission was

of the component which is being changed, withdrawn, or deleted. In the case of WDR, a UN ID may not exist. Ref Submitter CR ID Unique Submitter CR ID Required for Withdrawal. Required. This is the mechanism by which references to your

original submission are maintained. CR Status Date CR Status TBG17 Comment TBG17 use only. TBG17 use only. TBG17 use only.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 24 of 28

Input Heading TDED

Optional/Required Optional. Reference a TDED component number, if applicable.

Unqualified Data Type Worksheet (uDT) This worksheet contains the same columns as the qDT spreadsheet, but provides the details of the existing ATG-provided unqualified data types. The qDT spreadsheet SHOULD NOT be altered in this worksheet. If the Submitter considers to add or to change uDTs, the Submitter can submit Directory Maintenance Requests (DMRs) to ATG. The uDT DMR forms and procedures are provided by ATG. Using the Template The Harmonization team wants this to be as easy a process as possible while at the same time ensuring accurate, consistent submissions across business domains. This being the case, the workbook contains macros that make it easier to complete the required column entries. The Harmonization Team strongly suggests that before you make any additions to the spreadsheet that you make a copy of the original and save the one on which you will be working to a different name. CC Worksheet and BIE Worksheet Depending on the type of core component you are creating, the macros embedded within the workbook will assist you. To enter a new CC, enter the type of CC you wish to enter in column “C” and press the enter key. This will bring up a dialog box, in which to, enter the appropriate information, and the required columns will be completed for you – including the appropriate colour for the columns.


If a column is shaded or hidden, it is not appropriate for that row entry and information entered in that row is ignored. As a general practice, you should always give as much information as possible by using the optional columns. The “Working comments and instructions” column (F) should be used freely. The Dictionary Entry Name is a generated column and MUST NOT BE ALTERED. The name is generated based on the information you enter in other columns.



 

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 25 of 28

qDT Worksheet To enter a new data type, type DT in column “C” and press the enter key. This will bring up a dialog box, in which you enter the appropriate information, and the required columns are completed for you – including the appropriate colour for the columns. In addition, the macro will populate rows for the Content Component and all Supplementary Components (SC) for the underlying unqualified Data Type. Simply delete the SCs you do not want.


If a column is shaded or hidden, it is not appropriate for that row entry and information entered in that row is ignored. As a general practice, you should always give as much information as possible by using the optional columns. The “Working comments and instructions” column (F) should be used freely. The Dictionary Entry Name is a generated column and MUST NOT BE ALTERED. The name is generated based on the information you enter in other columns.



 

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 26 of 28

Reference 2. Change Request Form for CCL

Change Request Form for CCL
Reference Information
UN LOG: Request Group: User ref : User date: UN DATE :

Contact person name: Company: Address: Email: Phone:

Change Target
DEN (ACC or ABIE):

Purpose of Change
Change Purpose:

Business Need/justification:

Attached Documents
BRS: RSM or Class Diagram : Submission Spreadsheet: (Required) Others:

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 27 of 28

Reference 3. Submission Assessment Checklist The Submission Assessment Checklist can be found at http://www.uncefactforum.org/TBG/TBG17/tbg17.htm. Reference 4. Definition Boilerplate The Definition Boilerplate can be found at http://www.uncefactforum.org/TBG/TBG17/tbg17.htm. Reference 5. Controlled Vocabulary The Controlled Vocabulary is a living document. The current version of Controlled Vocabulary is synchronized with the current version of CCL (Posted Draft CCL). The Controlled Vocabulary can be found at http://www.uncefactforum.org/TBG/TBG17/tbg17.htm.

TBG17 CCL(Core Component Library) Submission Guidelines and Procedures Page 28 of 28