Customer Information Quality Specifications Version 3.0 Release Notes

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

03 October 2008

OASIS CIQ xPRL V3.0 PRD 01 Package Overview and Installation Procedure03 October 2008

1About 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 ( to understand the contents of the package and how to install the package.

1.1Name of the Package Downloaded

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

1.2Pre-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 ( 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 PRD01.zip” package.

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 MUSTupgrade 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 November2008 release are provided in the November2008 release package (OASIS CIQ v3.0 CS02.zip).

1.3Extracting 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 PRD01.zip) into a temporary folder. This folder can be deleted later after successful installation.

Extracting the package creates the following directory structure:

1.4Copying 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.1Impact

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.2Files 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.1Option 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 “xPRL.xsd” and “xPRL-types.xsd” files under “\ciq-xprl-v3\ciq\v3.0\xsd\default\xsd” into “\ciq-v3\ciq\v3.0\xsd\default\xsd”

1.4.2.2Option 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 “xPRL.xsd” file under “\ciq-xprl-v3\ciq\v3.0\xsd\genericode\xsd” into “\ciq-v3\ciq\v3.0\xsd\genericode\xsd”.

1.5Verifying 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.

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.

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.1Verifying 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.2Verifying 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.3Verifying 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.

2Customising 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 CIQXML schemas to meet your requirements. This section is applicable to xPRL also.

OASIS CIQ xPRL V3.0 PRD 01 Package Overview and Installation Procedure03 October 2008