ciq message

Subject: FW: RE: [ciq] FW: use of CIQ for representing party information

From: "kumar.sydney@gmail.com" <kumar.sydney@gmail.com>
To: <ciq@lists.oasis-open.org>, <Colin.Wallis@dia.govt.nz>
Date: Wed, 24 Mar 2010 04:38:26 +0000 (UTC)



Hi,

Enclosed is the sample XML document that was validated against OASIS CIQ V3.0 CS02.
I have enclosed a sample wrapper to xPIL. You need to set up the environment to validate this XML document as it uses other schemas in the CIQ package. If you have downloaded and installed the CIQ package as per instructions, then you can test this XML document by putting the enclosed two files under 
"OASIS CIQ V3.0 CS02\ciq-v3\ciq\v3.0\xsd\default\examples\xPIL"
Please read the sample XML document for my comments.

Regards,

Ram
 
> -----Original Message-----
> From: Elena Webb 
> Sent: Wednesday, 24 March 2010 2:53 p.m.
> To: Colin Wallis; 'Peter Furnish'; 'kumar.sydney@gmail.com '; 
> Peter Furnish
> Subject: RE: use of CIQ for representing party information
> 
> Hi Ram,
> 
> Thank you for your response - this is great and simplifies 
> the use of CIQ lot.
> 
> Taking your offer  - here is an example for you to show how 
> it can be represented in XML using
> CIQ:
> 
> Customer - John Smith orders Birth certificate on-line.
> 
> The following data needs to be exchanged between systems 
> Alpha and Beta using CIQ:
> 
> 1.	Customer Name - John Smith
> 2.	Customer Preadopted Name - Peter TheGreat
> 3.	Adopted Fathers Names  - Alan Smith
> 4.	Amount Due - $17 - this is the amount required to be 
> paid by the customer for ordering birth certificate on-line
> 5.	Credit Card Type - VISA - this is the type of Credit 
> Card supplied by the customer for payment
> 6.	Credit Card Expiry - 01/2011
> 7.	Credit Card Name - John Smith
> 8.	Customer Date Of Birth - 10/12/1980
> 9.	Customer Email - johny@johnymail.com
> 10.	Customer Place Of Birth - Paris, France
> 
> Thank you for your cooperation,
> 
> Elena Webb
> Enterprise Architect
> Information & Technology Group
> The Department of Internal Affairs Te Tari Taiwhenua
> Direct Dial: +64 4 4748194 x8194
> Mobile: +64 272677552
> www.dia.govt.nz
> 
> -----Original Message-----
> From: Colin Wallis 
> Sent: Wednesday, 24 March 2010 11:06 a.m.
> To: 'Peter Furnish'; Elena Webb
> Subject: FW: use of CIQ for representing party information
> Importance: High
> 
> First response in from the OASIS CIQ Chair....very helpful.
> 
> And I think we should take him up on his offer to stand up 
> some XML if we give him a clearer actual example (using 
> fictitious data of course).
> 
> Cheers
> 
> Colin
> 
> -----Original Message-----
> From: kumar.sydney@gmail.com [mailto:kumar.sydney@gmail.com] 
> Sent: Wednesday, 24 March 2010 10:55 a.m.
> To: ciq@lists.oasis-open.org; Colin Wallis
> Subject: RE: use of CIQ for representing party information
> 
> 
> > From: Peter Furnish
> > Sent: Tuesday, 23 March 2010 4:16 p.m.
> > To: Elena Webb; Colin Wallis
> > Subject: RE: use of CIQ for representing party information
> > 
> > Elena, Colin
> > 
> > My take on the use of CIQ for your possible scenarios is as follows.
> > 
> > 
> > 1.     Fathers Given Names - the names of the father 
> > associated with the life event product being ordered by the 
> > customer, e.g. customer orders his/hers BirthCertificate on-line.
> > 
> > > 
> > Do we use combination of xPRL and xNL ?
> > 
> > xPRL to show relationship between Customer and the Farther
> > 
> > and xNL to represent Fathers Given Names as a Person Name 
> > under this relationship?
> > 
> > PF - Yes, you use a combination of xPIL, xPRL and xNL. You 
> > would need to create two Party xPIL entities one for the 
> > customer and the other for the father, assuming each party 
> > would then have a PartyName xNL, then each party is linked 
> > together using xPRL Relationships.>>
> 
> If you want to create a relationship between customer and 
> father, then xPRL is the choice.
> If you do not want to create a relationship and instead have 
> something as follows:
> David Blackwell
> Son of John Blackwell
> Then, xNL will suffice.
> 
> xPIL will be useful when you want to provide details about 
> the customer like their telephone, email,
> Name, address, etc. If you want to also have details of the 
> customer, the customer's father as well as
> The relationship between the two, use xPRL. Note that xPIL 
> uses xNL and xAL and xPRL uses xPIL.
> 
> > 
> > 
> > 
> > 2.     Place of Event - The location that the life event took 
> > place (e.g. Place of Birth, Place of Death, Place of Marriage).
> 
> > 
> > 
> > Do we use combination of xPIL and xAL :
> > 
> > xPIL to represent the event (e.g. Birth) and xAL to represent 
> > the locality of this event ?
> > 
> > 
> > 
> > <<PF - Yes, you use a combination of xPIL and xAL as you 
> > described above. You would need to create a Party xPIL entity 
> > for each place of event and link it to an xAL address. 
> > Assuming that an event also involves a named individual this 
> > should also be associated with a named person, in which case 
> > you would need a xNL Name. As there is only one party there 
> > is no relationship requirement.>>
> 
> Again, please note that xPIL uses xNL and xAL, and xPRL uses xPIL.
> So, xPIL will help one to define birth details, person's name 
> and address and other
> Details such as credit card, telephone, email, of the person.
> 
> > 
> > 
> > 3.     Credit Card Name  -  The cardholder name of the credit 
> > card supplied by the customer for payment.
> > 
> > 
> > 
> > Do we use combination of xPIL  and xNL :
> > 
> > xPIL to represent account (credit card) and xNL to represent 
> > PersonName? Or we only use xNL to represent PersonName?
> > 
> > 
> > <<PF - Yes, you use a combination of xPIL and xNL as you 
> > described above. You would need to create a Party xPIL entity 
> > for each cardholder and link it to an xNL Name. As there is 
> > only one party there is no relationship requirement.>>
> > 
> 
> Please see my answer above. xPIL uses xNL and xAL.
> 
> If you have a clear example, I can always show how it can be 
> represented in XML using
> CIQ.
> 
> Regards,
> 
> Ram Kumar
> Chair, OASIS CIQ TC
> > 
> > 
> > 
> > << PF Note. The above interpretation is based on the 
> > following. The CIQ xPIL Specification does make provision for 
> > simple one to one relationships to be carried without the 
> > need for the use of xPRL. This simplifies the xml required 
> > and would remove the need for xPRL.. However the CIQ v3 spec 
> > states "... It is stongly advised that users interested in 
> > implementing relationships between parties using CIQ 
> > specifications SHOULD use CIQ xPRL specification version 3.0 
> > exclusively ...". I guess what this means is that the xPRL 
> > standard was developed later than xPIL and extends and does a 
> > proper job on relationships. This interpretation needs confirming.>>
> > 
> > 
> > 
> > Colin, very happy for you to bounce this off your contacts in 
> > the CIQ world.
> > 
> > 
> > 
> > Peter
> > 
> > Peter Furnish
> > Senior Standards Analyst, GTS
> > The Department of Internal Affairs Te Tari Taiwhenua
> > New Zealand Government
> > PO Box 10-526, Wellington 6143
> > +64 4 463 1332 or extn 4332
> > peter.furnish@dia.govt.nz<mailto:adrian.millar@dia.govt.nz>
> > www.dia.govt.nz<http://www.dia.govt.nz/>
> > 
> > 
> > 
> > 
> > From: Elena Webb
> > Sent: Tuesday, 23 March 2010 11:42 a.m.
> > To: Colin Wallis; Peter Furnish
> > Subject: use of CIQ for representing party information
> > Importance: High
> > 
> > Hi Colin and Peter,
> > 
> > As discussed with Colin on the phone earlier this morning I 
> > need your advice on how we use different parts of CIQ such as 
> > xNL, xAL, xPIL and xPRL to exchange customer related 
> > information on Life Event requests (for Births Deaths 
> > Marriage certificate information etc).
> > 
> > I have specific examples:
> > 
> > 
> > 4.     Fathers Given Names - the names of the father 
> > associated with the life event product being ordered by the 
> > customer, e.g. customer orders his/hers BirthCertificate on-line.
> > 
> > 
> > 
> > Do we use combination of xPRL and xNL ?
> > 
> > xPRL to show relationship between Customer and the Farther
> > 
> > and xNL to represent Fathers Given Names as a Person Name 
> > under this relationship?
> > 
> > 
> > 
> > 5.     Place of Event - The location that the life event took 
> > place (e.g. Place of Birth, Place of Death, Place of Marriage).
> > 
> > 
> > 
> > Do we use combination of xPIL  and xAL :
> > 
> > xPIL to represent the event (e.g. Birth) and xAL to represent 
> > the locality of this event ?
> > 
> > 
> > 
> > 6.     Credit Card Name  -  The cardholder name of the credit 
> > card supplied by the customer for payment.
> > 
> > 
> > 
> > Do we use combination of xPIL  and xNL :
> > 
> > xPIL to represent account (credit card) and xNL to represent 
> > PersonName? Or we only use xNL to represent PersonName?
> > 
> > 
> > 
> > I will appreciate it if you can confirm that with the CIQ TC.
> > 
> > 
> > 
> > As I have mentioned to Colin - these are specific examples of 
> > Data Exchanges for the project I am currently working on 
> > ...mapping data items to CIQ v3 elements and I will highly 
> > appreciate your advice by Monday 29 March 2010.
> > 
> > 
> > 
> > Please let me know if any additional information is required.
> > 
> > 
> > 
> > thank you,
> > 
> > 
> > 
> > 
> ______________________________________________________________

<?xml version="1.0" encoding="UTF-8"?>
<!--Sample schema to demonstrate use of party information from another namespace-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"; xmlns="urn:acme.org:corporate:customers" xmlns:p="urn:oasis:names:tc:ciq:xpil:3" xmlns:ct="urn:oasis:names:tc:ciq:ct:3" targetNamespace="urn:acme.org:corporate:customers">
	<xs:annotation>
		<xs:documentation> 
		Example Name: OASIS CIQ TC - sample-xPIL-wrapper
		Description: Defines a wrapper for xPIL schema to produce examples
		(Using standard code list/enumeration mechanism)
		Produced by: OASIS Customer Information Quality Technical Committee
		URL: http://www.oasis-open.org/committees/ciq
		Version: 3.0  
		Status: Committee Specification CS02
		Copyright: 2007-09, OASIS, http://www.oasis-open.org
		Last Modified: 20 September 2008
		Last Modified by: Ram Kumar, Chair, OASIS CIQ TC 
		
	</xs:documentation>
	</xs:annotation>
	<xs:import namespace="urn:oasis:names:tc:ciq:xpil:3" schemaLocation="..\..\xsd\xPIL.xsd"/>
	<xs:element name="Customers">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="p:Party" maxOccurs="unbounded"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

<?xml version="1.0"?>
<!--
	Example Name: OASIS CIQ TC - xPIL
Customer - John Smith orders Birth certificate on-line.

The following data needs to be exchanged between systems Alpha and Beta using CIQ:

1.	Customer Name – John Smith
2.	Customer Preadopted Name – Peter TheGreat
3.	Adopted Fathers Names  - Alan Smith
4.	Amount Due - $17 – this is the amount required to be paid by the customer for ordering birth certificate on-line
5.	Credit Card Type – VISA – this is the type of Credit Card supplied by the customer for payment
6.	Credit Card Expiry – 01/2011
7.	Credit Card Name - John Smith
8.	Customer Date Of Birth – 10/12/1980
9.	Customer Email – johny@johnymail.com
10.	Customer Place Of Birth – Paris, France

		Produced by: OASIS Customer Information Quality Technical Committee
		URL: http://www.oasis-open.org/committees/ciq
		Version Used : CIQ 3.0, Committee Specification CS02
		Copyright: 2007-09, OASIS, http://www.oasis-open.org 
		Created by: Ram Kumar, Chair, OASIS CIQ TC 
		Dated: 24 March 2010

		-->	
<c:Customers xmlns:c="urn:acme.org:corporate:customers" xmlns:a="urn:oasis:names:tc:ciq:xal:3" xmlns:n="urn:oasis:names:tc:ciq:xnl:3" xmlns:p="urn:oasis:names:tc:ciq:xpil:3" xmlns:ct="urn:oasis:names:tc:ciq:ct:3" xmlns:xlink="http://www.w3.org/1999/xlink"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="urn:acme.org:corporate:customers sample-xPIL-wrapper.xsd">
	<p:Party p:PartyType="online customer" >
	  <p:PartyName>
			<n:PersonName>
				<!-- 1.	Customer Name – John Smith -->
				<n:NameElement n:ElementType="Title">Mr</n:NameElement>
				<n:NameElement n:ElementType="FirstName">John</n:NameElement>
				<n:NameElement n:ElementType="LastName">Smith</n:NameElement>
			</n:PersonName>
			<!-- 2.	Customer Preadopted Name – Peter TheGreat -->
			<n:PersonName n:Type="Pre-adopted Name">  <!-- add this type to enumeration list -->
				<n:NameElement>Peter the Great</n:NameElement>
			</n:PersonName>
		</p:PartyName>
		
		<!-- 4.	Amount Due - $17 – this is the amount required to be paid by the customer for ordering birth certificate on-line.

Please note that CIQ focusses only on defining party centric attributes that help to uniquely identify and define party information and not on thing associated with the party. So, you need an XML schema that will handle specific things, but will use ciq for defining party centric attributes. If CIQ is defined to handle non party centric attributes, the CIQ cannot be application independent. CIQ is defined to be independent of applications or any vertical industries such as finance, manufacturing, etc. -->
		
<!--		
	6.	Credit Card Expiry – 01/2011
	7.	Credit Card Name - John Smith -->
	<p:Documents>
		<p:Document p:Type="CreditCard" ct:DateValidTo="2011-01-31T00:00:00"> 
			<p:NameOnDocument>
				<n:PersonName>
					<n:NameElement n:ElementType="FirstName">John</n:NameElement>
				<n:NameElement n:ElementType="LastName">Smith</n:NameElement>
				</n:PersonName>
			</p:NameOnDocument> 
			<p:IssuerName>
					<n:NameElement>VISA</n:NameElement>
			</p:IssuerName>
		</p:Document>
	</p:Documents>
	
	<!-- 9.	Customer Email – johny@johnymail.com	-->
	<p:ElectronicAddressIdentifiers>
		<p:ElectronicAddressIdentifier p:Type="EMAIL">johny@johnymail.com
		</p:ElectronicAddressIdentifier>
	</p:ElectronicAddressIdentifiers>
	
		<!-- 3.	Adopted Fathers Names  - Alan Smith -->
		<p:Relationships>
			<p:Relationship p:PartyType="Person" p:RelationshipWithPerson="Adopted Father">
				<n:PersonName>
					<n:NameElement n:ElementType="FirstName">Alan</n:NameElement>
					<n:NameElement n:ElementType="LastName">Smith</n:NameElement>
				</n:PersonName>
			</p:Relationship>
		</p:Relationships>
		
	<!--	8.	Customer Date Of Birth – 10/12/1980 
           10.	Customer Place Of Birth – Paris, France  -->
	<p:BirthInfo p:BirthDateTime="2980-12-10T00:00:00">
		<p:BirthPlaceDetails>
			<a:Country>
				<a:NameElement>France</a:NameElement>
			</a:Country>
			<a:AdministrativeArea a:Type="City">
				<a:NameElement>Paris</a:NameElement>
			</a:AdministrativeArea>
		</p:BirthPlaceDetails>
	</p:BirthInfo>
	
	</p:Party>
</c:Customers>