Customer Information Quality Specifications Version 3.0 – xPRL Package Overview and Installation Procedure

01 November 2009

 

Specification URIs:

 

This Version:

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.html

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.doc

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.pdf

 

Previous Version:

http://docs.oasis-open.org/ciq/v3.0/prd01/supp/ciq-xprl-v3-package-overview.html

http://docs.oasis-open.org/ciq/v3.0/prd01/supp/ciq-xprl-v3-package-overview.doc

http://docs.oasis-open.org/ciq/v3.0/prd01/supp/ciq-xprl-v3-package-overview.pdf

 

Latest Version:

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.html

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.doc

http://docs.oasis-open.org/ciq/v3.0/cs/supp/ciq-xprl-v3-package-overview.pdf

 

Technical Committee:

OASIS Customer Information Quality

 

Chair(s):

Ram Kumar (kumar.sydney@gmail.com)

 

Editor(s):

Ram Kumar (kumar.sydney@gmail.com)

 

Related work:

This version of the CIQ specifications replaces or supercedes:

·         OASIS CIQ extensible Customer Relationships Language (xCRL) V2.0 Committee Specification

 

Abstract:

This document provides an overview of the CIQ Specification xPRL V3.0 package that is available for download from the OASIS CIQ Technical Committee (TC) web site (http://www.oasis-open.org/committees/ciq).

 

Status:

This document was last revised or approved by the OASIS CIQ TC on the above date. The level of approval is also listed above. Check the current location noted above for possible later revisions of this document. This document is updated periodically on no particular schedule.

 

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at www.oasis-open.org/committees/ciq.

 

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (www.oasis-open.org/committees/ciq/ipr.php.

 

The non-normative errata page for this specification is located at www.oasis-open.org/committees/ciq.

 

Notices

Copyright © OASIS® 1993–2009. All Rights Reserved. OASIS trademark, IPR and other policies apply.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The names "OASIS", “CIQ”, “xNL”, “xAL”, xNAL”, “xPIL”, “xPRL”, “xCIL”, “xCRL” , “Genericode” and “UBL” are trademarks of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.

 

 

Table of Contents

1     About the Package.. 5

1.1 Name of the Package Downloaded.. 5

1.2 Pre-requisite - Important.. 5

1.3 Extracting and Installing the Package.. 5

1.4 Copying Files and the Impact to existing users. 6

1.4.1 Impact 6

1.4.2 Files to Copy. 6

1.4.2.1 Option 1 (Default) Related Files. 6

1.4.2.2 Option 2 (Genericode) Related Files. 7

1.5 Verifying Package Extraction and Installation.. 7

1.5.1 Verifying Test Results by testing the default test files of code lists provided. 9

1.5.2 Verifying Test Results by testing the customised test files of code lists provided. 10

1.5.3 Verifying the test results of metadata attributes of the code lists. 11

2     Customising your Code Lists / Enumerations. 12

A.       Acknowledgements. 13

B.       Intellectual Property Rights, Patents, Licenses and Royalties. 14

C.       Revision History.. 15

 

 


1        About the Package

The purpose of this document is to assist users who have downloaded the CIQ Specifications xPRL Version 3.0 package from the OASIS CIQ TC web site (http://www.oasis-open.org/committees/ciq) to understand the contents of the package and how to install the package.

1.1 Name of the Package Downloaded

The name of the package that was downloaded is “OASIS CIQ xPRL V3.0 CS.zip”.

1.2 Pre-requisite - Important

Before extracting and installing the package, you MUST download the “OASIS CIQ V3.0 Committee Specification CS02” package that was released on November 01, 2008. This package is available from OASIS CIQ TC web site (http://www.oasis-open.org/committees/ciq). The name of the package is “OASIS CIQ V3.0 CS02.zip”. Read the “OASIS CIQ Specification Version 3.0 – Package Overview document that is part of the package (OASIS CIQ V3.0 CS02.zip) to understand how to extract and install the package. This package MUST be installed before installing the “OASIS CIQ xPRL V3.0 CS.zip” package.

Also, read the minor bug report released on 04 June 2009. The link is:

http://www.oasis-open.org/committees/download.php/32789/OASIS%20CIQ%20V3.0%20CSO2%20Bugs%20Document.pdf

For those who have installed “OASIS CIQ V3.0 Committee Specification” package that was released on 26 November 2007, and want to include xPRL, they MUST upgrade it by downloading and installing “OASIS CIQ V3.0 Committee Specification CS02” package that was released in November 2008. Instructions on upgrading from the November 2007 release to the November 2008 release are provided in the November 2008 release package (OASIS CIQ v3.0 CS02.zip).

1.3 Extracting and Installing the Package

Once the November 2008 release package is downloaded, extracted and installed as advised, the next step is to install the xPRL Version 3.0 package and this section explains the steps.

Extract the package (OASIS CIQ xPRL V3.0 CS.zip) into a temporary folder. This folder can be deleted later after successful installation.

Extracting the package creates the following directory structure:

1.4 Copying Files and the Impact to existing users

Now, some of the files in the above directory SHOULD be copied into the directory structure created by extracting “OASIS CIQ V3.0 CS02.zip”. 

1.4.1 Impact

Existing users of OASIS CIQ Version 3.0 Specifications SHOULD have some impact as the addition of xPRL specification has resulted in new files for genericode files and it’s supporting utility programs.

OASIS CIQ TC sincerely apologies for this inconvenience caused. 

1.4.2 Files to Copy

Following are the list of files and folders that MUST be copied from the xPRL directory structure that you have created in a temporary folder to the directory where you have installed the November 2008 release of CIQ Version 3.0 Committee Specification 02 package.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\spec” into “\ciq-v3\ciq\v3.0\spec”

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\supp” into “\ciq-v3\ciq\v3.0\supp”

1.4.2.1 Option 1 (Default) Related Files

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\default\doc\xPRL” into “\ciq-v3\ciq\v3.0\xsd\default\doc\xPRL”

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\default\examples\xPRL” into “\ciq-v3\ciq\v3.0\xsd\default\examples\xPRL”.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\default\xsd” into “\ciq-v3\ciq\v3.0\xsd\ default\xsd”

 

1.4.2.2 Option 2 (Genericode) Related Files

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\customised\gc-files\xPRL” into “\ciq-v3\ciq\v3.0\xsd\genericode\customised\gc-files\xPRL”

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\customised\prepare” into “\ciq-v3\ciq\v3.0\xsd\genericode\customised\prepare”. Select “Yes” to replace all existing files with new files. Note that if you have modified any files under “\ciq-v3\ciq\v3.0\xsd\genericode\customised\prepare”, they will be overwritten. If you do not want them to be overwritten, then you need to save the files you changed or created so that you can reapply the changes once the files are copied.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\customised\test” into “\ciq-v3\ciq\v3.0\xsd\genericode\customised\test”. Select “Yes” to replace all existing files with new files. Note that if you have modified any files under “\ciq-v3\ciq\v3.0\xsd\genericode\customised\test”, they will be overwritten. If you do not want them to be overwritten, then you need to save the files you changed or created so that you can reapply the changes once the files are copied.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\default\gc-files\xPRL” into “\ciq-v3\ciq\v3.0\xsd\genericode\default\gc-files\xPRL”

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\default\prepare” into “\ciq-v3\ciq\v3.0\xsd\genericode\default\prepare”. Select “Yes” to all existing files to be replaced with new files. Note that if you have modified any files under “\ciq-v3\ciq\v3.0\xsd\genericode\default\prepare”, they will be overwritten. If you do not want them to be overwritten, then you need to save the files you changed or created so that you can reapply the changes once the files are copied.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\default\test” into “\ciq-v3\ciq\v3.0\xsd\genericode\default\test”. Select “Yes” to replace all existing files with new files. Note that if you have modified any files under “\ciq-v3\ciq\v3.0\xsd\genericode\default\test”, they will be overwritten. . If you do not want them to be overwritten, then you need to save the files you changed or created so that you can reapply the changes once the files are copied.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\doc\xPRL” into “\ciq-v3\ciq\v3.0\xsd\genericode\doc\xPRL”

·         Copy all files and folders under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\utility” into “\ciq-v3\ciq\v3.0\xsd\genericode\utility”. Select “Yes” to replace all existing files with new files. Note that if you have modified any files under “\ciq-v3\ciq\v3.0\xsd\genericode\utility”, they will be overwritten. . If you do not want them to be overwritten, then you need to save the files you changed or created so that you can reapply the changes once the files are copied.

·         Copy all files under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\xsd” into “\ciq-v3\ciq\v3.0\xsd\genericode\xsd”.

1.5 Verifying Package Extraction and Installation

This section will help verify whether the above procedures have been successfully followed through some series of tests.

If you had some newly created or modified files before you performed the above process, make sure that those changes are re-applied. If you do not have any such changes, go straight to section 1.5.1 Else, follow the steps below:

You need to “prepare” the default genericode files and the customized genericode files.

1.       Go to “ciq-v3\ciq\v3.0\xsd\genericode\default\prepare”. Run “prepare-default-cl.bat” or “prepare-default-cl.sh” depending upon your operating system. The final output (last couple of statements) should be as follows. If it is not the case, then you need to re-check your fixes. No errors should be reported.

 

 

2.       Go to “ciq-v3\ciq\v3.0\xsd\genericode\customised\prepare”. Run “prepare-customised-cl.bat” or “prepare-customised-cl.sh” depending upon your operating system. The final output (last couple of statements) should be as follows. If it is not the case, then you need to re-check your fixes. No errors should be reported.

1.5.1 Verifying Test Results by testing the default test files of code lists provided

By running the “test-all.bat” or “test-all.sh” in the “genericode\default\test” directory, the following result should occur.

 

 

 

 

 

 

 

 

 

 

 

1.5.2 Verifying Test Results by testing the customised test files of code lists provided

By running the “test-all.bat” or “test-all.sh” in the “genericode\customised\test” directory, the following result should occur.

 

1.5.3 Verifying the test results of metadata attributes of the code lists

By running the “test-metadata.bat” or “test-metadata.sh” in the “genericode\customised\test” directory, the following result should occur.

2        Customising your Code Lists / Enumerations

Please read section 2 of “OASIS CIQ Specifications Version 3.0 – Committee Specification 02 Package Overview” to understand how to customise CIQ XML schemas to meet your requirements. This section is applicable to xPRL also.

A.   Acknowledgements

The following individuals have participated in the creation of xPRL Version 3.0 of CIQ specifications and are gratefully acknowledged:

Participants:

 

Colin Wallis

New Zealand Government

Voting Member, CIQ TC

David Webber

Individual

Voting Member, CIQ TC

Fulton Wilcox

Colts Neck Solutions LLC

Voting Member, CIQ TC

Graham Lobsey

Individual

Voting Member, CIQ TC

Joe Lubenow

Individual

Voting Member, CIQ TC

John Glaubitz

Vertex, Inc

Voting Member, CIQ TC

Michael Roytman

Vertex, Inc

Voting Member, CIQ TC

Ram Kumar

Individual

Chair and Voting Member, CIQ TC

 

OASIS CIQ Technical Committee (TC) sincerely thanks the public (this includes other standard groups, organisations and end users) for their continuous feedback and support that helps the TC to work toward improving the CIQ specifications.

Special thanks to Mr.Ken Holman, Chair of OASIS Code List TC (http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=codelist) for his support, guidance and genericode implementation assistance to the TC in releasing the OASIS Code List version of CIQ V3.0 XML Schemas.

Special thanks to Mr.Hugh Wallis, Director of Standards Development of extensible Business Reporting Language (xBRL) International Standards Group (http://www.xbrl.org) for working closely with the CIQ TC in jointly implementing W3C xLink specification that is now used by both xBRL and CIQ Specifications to enable interoperability between the two specifications.

Special thanks to Mr.Carl Reed, Chief Technology Officer of Open Geospatial Consortium (OGC – http://www.opengeospatial.org) for his guidance and assistance to the TC in referencing the work of OGC on GeoRSS and Geo-Coordinates for addresses/locations as part of CIQ Address Specifications.

OASIS CIQ TC also acknowledges the contributions from other former members of the TC since its inception in 2000.  

B.   Intellectual Property Rights, Patents, Licenses and Royalties

CIQ TC Specifications (includes documents, schemas and examples1 and 2) are free of any Intellectual Property Rights, Patents, Licenses or Royalties. Public is free to download and implement the specifications free of charge. 

 

1xAL-AustralianAddresses.xml

Address examples come from AS/NZ 4819:2003 standard of Standards Australia and are subject to copyright

 

2xAL-InternationalAddresses.xml

Address examples come from a variety of sources including Universal Postal Union (UPU) website and the UPU address examples are subject to copyright.

 

xLink-2003-12-31.xsd

This schema was provided by the xBRL group in December 2006.

 

C.   Revision History

Revision

Date

Editor

Changes Made

V3.0 WD 01

 02 December 2007

Ram Kumar  

First Version of Working Draft WD 01

V3.0 WD 02

15 February 2008

Ram Kumar

Revised Version of Working Draft WD 01  

V3.0 WD 03

25 February 2008

Ram Kumar

Final Version for inclusion as a supporting document for xPRL Committee Draft

V3.0 CD 01

03 March 2008

Ram Kumar

TC Approved document

V3.0 PRD 01

03 October 2008

Ram Kumar

Public Review Draft Document for 60 days public review

V3.0 CS

01 November 2009

Ram Kumar

Committee Specification