HR-XML 3.0 Standards, 2009  September  23.

Menu: [ Home  |  Guidelines  |  BODs  |  Nouns  |  Global elements  |  WSDL  |  Packages  |  Code Lists  |  Master Index ]

Trace back: » ch06s03 | ch07s02 | ch07s03 | ch08 | ch08s03 »

Indicative Data: Examples
Prev Chapter 8. Manage Indicative Data: Provisioning Outsourced Benefits and Payroll Systems Next

Indicative Data: Examples

Sometimes it is useful for an employer to communicate to a service provider its intent to hire an individual in advance of the individual's first day of work or "official hire" date. Such advanced notice can ensure that necessary preparations are made and delays avoided when the employee actually begins employment. For example, with the advanced notice, a benefits administrator might create a record in its system, so upon the individual's first day of work, he or she may enroll online in the employer's benefit programs.

The examples that follow illustrate a pre-hire notification to a service provider as well as a subsequent communication when the individual actually begins employment.

Example 8.1. Indicative Data: Pre-Hire Notice

In this example, information about "Jimmy Prehire" is sent to a service provider prior to his official hire or enter on duty. In the pre-hire message, note the following:

  • Since there is no existing record for Jimmy, the actionCode attribute of <oa:ActionExpression> is set to "Add" to communicate an instruction to create a new record.

  • The <ProposedHireDetails> element is used to specify the employee's anticipated first day of employment (2009-09-10).

  • <EmployedIndicator> has a value of "false" since the candidate is not yet officially an employee.

Source


<?xml version="1.0" encoding="UTF-8"?>
<SyncIndicativeData 
	systemEnvironmentCode="Production" 
	releaseID="3.0" 
	versionID="normalizedString" 
	languageCode="en-US" 
	xsi:schemaLocation="http://www.hr-xml.org/3 ../Developer/BODs/SyncIndicativeData.xsd" 
	xmlns="http://www.hr-xml.org/3" 
	xmlns:oa="http://www.openapplications.org/oagis/9" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<oa:ApplicationArea>
		<oa:CreationDateTime>2009-09-01</oa:CreationDateTime>
	</oa:ApplicationArea>
	<DataArea>
		<oa:Sync>
			<oa:ActionCriteria>
				<oa:ActionExpression actionCode="Replace">/SyncIndicativeData/DataArea/IndicativeData</oa:ActionExpression>
			</oa:ActionCriteria>
		</oa:Sync>
		<IndicativeData languageCode="en-US">
			<DocumentID>9987-12228</DocumentID>
			<EmployerIdentifiers>
				<OrganizationID>12345</OrganizationID>
			</EmployerIdentifiers>
			<IndicativePersonDossier>
				<IndicativePerson>
					<PersonLegalID schemeID="SSN" schemeAgencyID="US SSA">555-11-1111</PersonLegalID>
					<PersonName>
						<oa:GivenName>Jimmy</oa:GivenName>
						<FamilyName>PreHire</FamilyName>
					</PersonName><Communication>
					<Address>
					<oa:StreetName>Progress Street</oa:StreetName>
							<oa:Unit>5003</oa:Unit>
							<oa:CityName>Brooklyn</oa:CityName>
							<oa:CountrySubDivisionCode>NY</oa:CountrySubDivisionCode>
							<CountryCode>US</CountryCode>
							<oa:PostalCode>11217</oa:PostalCode>
                    </Address></Communication>
					<Communication>
					    <ChannelCode>Telephone</ChannelCode>
						<UseCode>Home</UseCode>
						<oa:CountryDialing>1</oa:CountryDialing>
						<oa:AreaDialing>212</oa:AreaDialing>
                        <oa:DialNumber>555 1212</oa:DialNumber>						
						</Communication>
					<Communication>
					    <ChannelCode>Email</ChannelCode>
						<UseCode>Personal</UseCode>
						<oa:URI>jimmy@home_domain.com</oa:URI>
					</Communication>
					<BirthDate>1961-04-05</BirthDate>
					<GenderCode>Male</GenderCode>
					<CertifiedMaritalStatus>
					     <MaritalStatusCode>Married</MaritalStatusCode>
					</CertifiedMaritalStatus>
				</IndicativePerson>
				<IndicativeEmployment>
					<!-- Employed Indicator is false since candidate is not yet officially hired.-->
					<EmployedIndicator>false</EmployedIndicator>
					<ProposedHire>
						<ExpectedDutyEntryDate>2009-09-10</ExpectedDutyEntryDate>
					</ProposedHire>
				</IndicativeEmployment>
			</IndicativePersonDossier>
		</IndicativeData>
	</DataArea>
</SyncIndicativeData>
<!--


Copyright The HR-XML Consortium. All Rights Reserved. http://www.hr-xml.org 
Copyright (c) 1997-2009 Open Applications Group, Inc. All Rights Reserved 
-->

Example 8.2. Indicative Data: Follow-Up Hire Notice

"Jimmy Prehire" has officially become an employee. This is communicated in a follow-up message. Note the following:

  • The trading partners are using the "snapshot" or "full-file" refresh approach to updating information. Therefore, the actionCode attribute of <oa:ActionExpression> is set to "Replace" The expression is left empty since it is assumed that the content provided will replace the record on the receiver's system in its entirety.

  • The official hire date (2009-09-16) differs from that of the anticipated first day of employment that was indicated in the pre-hire message.

Source


<?xml version="1.0" encoding="UTF-8"?>
<SyncIndicativeData 	
	systemEnvironmentCode="Production" 
	releaseID="3.0" 
	versionID="normalizedString" 
	languageCode="en-US" 
	xsi:schemaLocation="http://www.hr-xml.org/3 ../Developer/BODs/SyncIndicativeData.xsd" 	
	xmlns="http://www.hr-xml.org/3" 
	xmlns:oa="http://www.openapplications.org/oagis/9" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<oa:ApplicationArea>
		<oa:CreationDateTime>2009-09-16</oa:CreationDateTime>
	</oa:ApplicationArea>
	<DataArea>
		<oa:Sync>
			<oa:ActionCriteria>
				<!-- Use of "Replace" actionCode indicates "snapshot" or "full-file" refresh approach. -->
				<oa:ActionExpression actionCode="Replace">/SyncIndicativeData/DataArea/IndicativeData</oa:ActionExpression>
			</oa:ActionCriteria>
		</oa:Sync>
		<IndicativeData languageCode="en-US">
			<DocumentID>9987-12228</DocumentID>
			<EmployerIdentifiers>
				<OrganizationID>12345</OrganizationID>
			</EmployerIdentifiers>
			<IndicativePersonDossier>
				<IndicativePerson>
					<!-- Sending previously sent legal id, since that is how the 'Jimmy" was uniquely identified
				     in the previous documents (in this scenario employee ids are not given
				     until actually hired and employee reports for their first day of work)
				-->
					<PersonLegalID schemeID="SSN" schemeAgencyID="US SSA">555-11-1111</PersonLegalID>
					<PersonName>
						<oa:GivenName>Jimmy</oa:GivenName>
						<FamilyName>PreHire</FamilyName>
					</PersonName><Communication>
					<Address>
							<oa:StreetName>Progress Street</oa:StreetName>
							<oa:Unit>5003</oa:Unit>
							<oa:CityName>Brooklyn</oa:CityName>
							<oa:CountrySubDivisionCode>NY</oa:CountrySubDivisionCode>
							<CountryCode>US</CountryCode>
							<oa:PostalCode>11217</oa:PostalCode>
						</Address></Communication>
					<Communication>
					     <ChannelCode>Telephone</ChannelCode>
						<UseCode>Home</UseCode>
						<oa:AreaDialing>212</oa:AreaDialing>
                        <oa:DialNumber>555 1212</oa:DialNumber>
                    </Communication>
					<Communication>
					     <ChannelCode>Email</ChannelCode>
						<UseCode>Personal</UseCode>
						<oa:URI>jimmy@home_domain.com</oa:URI>
					</Communication>
					<BirthDate>1961-04-05</BirthDate>
					<GenderCode>Male</GenderCode>
					<CertifiedMaritalStatus>
						<MaritalStatusCode>Married</MaritalStatusCode>
					</CertifiedMaritalStatus>
					</IndicativePerson>
				<IndicativeEmployee>
					<!-- we now have an employee id for Jimmy.  Used a personal id in previous documents -->
					<EmployeeID>1212-4321-99</EmployeeID>
					</IndicativeEmployee>
				<IndicativeEmployment>
				<!-- IsEmployed is now 'true' -->
					<EmployedIndicator>true</EmployedIndicator>
					<EmploymentLifecycle>
					<!-- Official hire date -->
						<Hire>
							<HireDate>2009-09-16</HireDate>
						</Hire>
					</EmploymentLifecycle>
				</IndicativeEmployment>
				<IndicativeDeployment>
					<ResourceRelationshipCode>Employee</ResourceRelationshipCode>
					<DeploymentOrganization>
						<OrganizationalIdentifiers>
							<OrganizationalID schemeID="Division Code">11111</OrganizationalID>
						</OrganizationalIdentifiers>
					</DeploymentOrganization>
                    <WorkLocation>	
                        <Address>
							<oa:BuildingNumber>830</oa:BuildingNumber>
							<oa:StreetName>44th Street</oa:StreetName>
							<oa:Unit>Suite 100</oa:Unit>
							<oa:CityName>New York</oa:CityName>
							<oa:CountrySubDivisionCode>NY</oa:CountrySubDivisionCode>
							<CountryCode>US</CountryCode>
							<oa:PostalCode>10021</oa:PostalCode>
						</Address>
	                </WorkLocation>
			   <Communication>
                        <ChannelCode>Telephone</ChannelCode>					
						<UseCode>Personal</UseCode>
						<oa:AreaDialing>212</oa:AreaDialing>
						<oa:DialNumber>555 5555</oa:DialNumber>
				</Communication>
			   <Communication>
                        <ChannelCode>Mobile Telephone</ChannelCode>					
						<UseCode>Business</UseCode>
						<oa:AreaDialing>212</oa:AreaDialing>
						<oa:DialNumber>555 5555</oa:DialNumber>
				</Communication>
					<Communication>
					    <ChannelCode>Email</ChannelCode>
						<UseCode>Business</UseCode>
						<oa:URI>jPrehire@widgetGlobal.com</oa:URI>
					</Communication>
					<IndicativePosition>
						<RemunerationBasisCode>Salaried</RemunerationBasisCode>
					</IndicativePosition>
				</IndicativeDeployment>
				<PayCycleRemuneration>
					<Remuneration validFrom="2009-10-05">
						<oa:Amount currencyID="USD">50000.00</oa:Amount>
						<RemunerationRateIntervalCode>Year</RemunerationRateIntervalCode>
						<RemunerationTypeCode>Base Pay</RemunerationTypeCode>
					</Remuneration>
				</PayCycleRemuneration>
			</IndicativePersonDossier>
		</IndicativeData>
	</DataArea>
</SyncIndicativeData>
<!--


Copyright The HR-XML Consortium. All Rights Reserved. http://www.hr-xml.org 
Copyright (c) 1997-2009 Open Applications Group, Inc. All Rights Reserved 
-->

Links to Additional Indicative Data Examples

GetIndictiveData - Example 1

GetIndictiveData - Example 2

SyncIndictiveData - William New Hire

SyncIndictiveData - Example 1

Prev Up Next
Indicative Data: Supporting Library Components Home Chapter 9. Manage User Account

Comment on this Component

Use the form below to submit your question or comment about "ch08s03"

By submitting you indicate that you are accepting HR-XML's Feedback Policy

  * = required field
First/Given Name: *
Last/Family Name: *
Position Title:
Organization:
Country:
Website:
E-mail: *
Topic:
  Please use the area below to write your comment or question: