Person 02

The Person 02 is used to automate a regular feed from an external source to import people records into the application. The Person 02 populates fields located in the General and Profile section of the person’s system record.

Import Directory Formats are typically created by vendor partners. The format provided below is required if you intend to automate a regular feed from an external source.

Person02-insert.xml Sample


<Data>
<Header>
<ImportDirective>PERSON02</ImportDirective>
<Methods>
<RemovableGroupAbrvChs VarType="88">BiC,BiS,BiA</RemovableGroupAbrvChs>
<RemovableCanActAsAbrvChs VarType="88">EX,Dep,SGT,LT</RemovableCanActAsAbrvChs>
<RemovableSpecAbrvChs VarType="88">CPR,FTO,RT,DRE,RIFLE,ARM,TRANS</RemovableSpecAbrvChs>
<ImportKey>RscMasterExternalIDCh</ImportKey>
<AllOrNone>False</AllOrNone>
</Methods>
</Header>
<Rows>
<Row Action="Insert">
<RscMasterFNameCh>Scott</RscMasterFNameCh>
<RscMasterMNameCh>P</RscMasterMNameCh>
<RscMasterLNameCh>Doe</RscMasterLNameCh>
<RscMasterFromDa>01/01/2001</RscMasterFromDa>
<RscMasterThruDa>01/01/9999</RscMasterThruDa>
<RscMasterContact1Ch>(714)555-1212</RscMasterContact1Ch>
<RscMasterContact2Ch>(800)555-1212</RscMasterContact2Ch>
<RscMasterContact3Ch>(909)555-1212</RscMasterContact3Ch>
<RscMasterContact4Ch>(111)555-1212</RscMasterContact4Ch>
<RscMasterAddress1Vc>124 Main St.</RscMasterAddress1Vc>
<RscMasterAddress2Vc>Appt G2</RscMasterAddress2Vc>
<RscMasterCityVc>Irvine</RscMasterCityVc>
<RscMasterStateCh>CA</RscMasterStateCh>
<RscMasterZipCh>92606</RscMasterZipCh>
<RscMasterSpouseCh>N</RscMasterSpouseCh>
<RscMasterEmployeeIDCh>laaa</RscMasterEmployeeIDCh>
<RscMasterPayrollIDCh>laaa</RscMasterPayrollIDCh>
<RscMasterExternalIDCh>laaa</RscMasterExternalIDCh>
<RscMasterLoginNameCh>laaa</RscMasterLoginNameCh>
<RscMasterBadgeIDCh>A-37488</RscMasterBadgeIDCh>
<RscMasterRaceTi>M</RscMasterRaceTi>
<RscMasterSexTi>M</RscMasterSexTi>
<RscMasterBirthdateDa>01/01/1970</RscMasterBirthdateDa>
<RscMasterDisableSi>N</RscMasterDisableSi>
<InstitutionAbrvCh>1</InstitutionAbrvCh>
<SetupFiltersIn></SetupFiltersIn>
<AuthNoIn>8</AuthNoIn>
<Resources>
<Resource>
<RscExternalIDCh>10-000533-2</RscExternalIDCh>
<RscFromDa>01/01/2000</RscFromDa>
<RscThruDa>02/29/2015</RscThruDa>
<JobAbrvCh>FF</JobAbrvCh>
<RscPromotionDt>03/01/2013</RscPromotionDt>
<RscHireDt>01/01/2001</RscHireDt>
<SpecAbrvChs>ARSON,HM</SpecAbrvChs>
<CanActAsAbrvChs>E,BC</CanActAsAbrvChs>
<GroupAbrvChs>BL</GroupAbrvChs>
<RscHourWageDB>53.00</RscHourWageDB>
<RscSeniorityIn>8</RscSeniorityIn>
</Resource>
<Resource>
<RscExternalIDCh>10-000533-1</RscExternalIDCh>
<RscFromDa>03/01/2012</RscFromDa>
<RscThruDa>01/01/9999</RscThruDa>
<JobAbrvCh>BC</JobAbrvCh>
<RscPromotionDt>03/01/2012</RscPromotionDt>
<RscHireDt>01/01/2000</RscHireDt>
<CanActAsAbrvChs></CanActAsAbrvChs>
<GroupAbrvChs></GroupAbrvChs>
<!DOCTYPE Data>
<Data>
<Rows>
		<Row Action="Insert" Optional="True">
<RscMasterFNameCh>Scott</RscMasterFNameCh>
<RscMasterMNameCh>P</RscMasterMNameCh>
<RscMasterLNameCh>Doe</RscMasterLNameCh>
<RscMasterExternalIDCh>laaa</RscMasterExternalIDCh>
<Resources>
				<Resource>
			<TargetDate>04/30/2017</TargetDate>
			<JobAbrvCh>E</JobAbrvCh>
					<ListOfUDFs>
		<UDF>
							<name>UdfEx1String</name>
							<value>TextString</value>
						</UDF>
						<UDF>
							<name>UdfEx2Date</name>
							<value>09/01/2018</value>
						</UDF>
						<UDF>
							<name>UdfEx3Boolean</name>
							<value>True</value>
						</UDF>
						<UDF>
							<name>UdfEx4Number</name>
							<value>12345</value>
						</UDF>
					</ListOfUDFs>
				</Resource>
			</Resources>
		</Row>
	</Rows>
</Data>
</Resource>
</Resources>
</Row>
</Rows>
</Data>

Person02-update.xml Sample

<Data>
<Header>
<ImportDirective>PERSON02</ImportDirective>
<Methods>
<RemovableGroupAbrvChs VarType="88">BiC,BiS,BiA</RemovableGroupAbrvChs>
<RemovableCanActAsAbrvChs VarType="88">EX,Dep,SGT,LT</RemovableCanActAsAbrvChs>
<RemovableSpecAbrvChs VarType="88">CPR,FTO,RT,DRE,RIFLE,ARM,TRANS</RemovableSpecAbrvChs>
<ImportKey>RscMasterExternalIDCh</ImportKey>
<AllOrNone>False</AllOrNone>
</Methods>
</Header>
<Rows>
<Row Action="Update">
<RscMasterFNameCh>Scott(edited)</RscMasterFNameCh>
<RscMasterMNameCh>E</RscMasterMNameCh>
<RscMasterLNameCh>Doe(edited)</RscMasterLNameCh>
<RscMasterFromDa>01/01/2002</RscMasterFromDa>
<RscMasterThruDa>01/01/2020</RscMasterThruDa>
<RscMasterContact1Ch>(714)555-1213</RscMasterContact1Ch>
<RscMasterContact2Ch>(800)555-1213</RscMasterContact2Ch>
<RscMasterContact3Ch>(909)555-1213</RscMasterContact3Ch>
<RscMasterContact4Ch>(111)555-1213</RscMasterContact4Ch>
<RscMasterAddress1Vc>124 Main St.(edited)</RscMasterAddress1Vc>
<RscMasterAddress2Vc>Appt G2(edited)</RscMasterAddress2Vc>
<RscMasterCityVc>Irvine(edited)</RscMasterCityVc>
<RscMasterStateCh>NV</RscMasterStateCh>
<RscMasterZipCh>92607</RscMasterZipCh>
<RscMasterSpouseCh>Y</RscMasterSpouseCh>
<RscMasterEmployeeIDCh>maaa</RscMasterEmployeeIDCh>
<RscMasterPayrollIDCh>maaa</RscMasterPayrollIDCh>
<RscMasterExternalIDCh>laaa</RscMasterExternalIDCh>
<RscMasterLoginNameCh>maaa</RscMasterLoginNameCh>
<RscMasterBadgeIDCh>B-37488</RscMasterBadgeIDCh>
<RscMasterRaceTi>C</RscMasterRaceTi>
<RscMasterSexTi>F</RscMasterSexTi>
<RscMasterBirthdateDa>01/01/1972</RscMasterBirthdateDa>
<RscMasterDisableSi>N</RscMasterDisableSi>
<SetupFiltersIn></SetupFiltersIn>
<AuthNoIn>1</AuthNoIn>
<Resources>
<Resource>
<RscExternalIDCh>10-000533-2</RscExternalIDCh>
<JobAbrvCh>E</JobAbrvCh>
</Resource>
<Resource>
<TargetDate>03/01/2025</TargetDate>
<RscFromDa/>
<RscThruDa/>
<JobAbrvCh/>
<RscPromotionDt/>
<RscHireDt/>
<CanActAsAbrvChs/>
<GroupAbrvChs/>
</Resource>
</Resources>
</Row>
</Rows>
</Data>

DATA

Header

ImportDirective

The header field is required. It identifies the import format within the <Data> section. The Ongoing Import will reject an illegal ImportDirective value. Legal values are the names of the variations found in the sample files.

Version

The version field is optional. It is used to ensure that a given import file only works against that specific version of the application. Simply put, if you want the import to fail when a major upgrade occurs, set the version number. If irrelevant because these interfaces are maintained across versions, then omit this section.

Methods

The methods section is optional if the default values below are as desired. If not, include the method that you want to override.

Field Name Format Description
Import Key One of...
  • PayrollID (default)
  • EmployeeID
  • ExternalID
 A tag with the same name as this selection must exist as in the supplied XML file for each <Row>. PayrollID is assumed if the method is not supplied.
AllorNone True (default) or False If TRUE, any failure to insert/update a record within the application will rollback all changes made prior to the failure and exit the program. If FALSE, insert or update failures will be logged but successful inserts or updates will be saved.
InsertNew True (default) or False If TRUE, it is okay to insert new records into the application.
UpdateExisting True (default) or False If TRUE, it is okay to update existing records within the application.
RemovableGroupAbrvChs string list (comma delimited) If the <resource> section’s <GroupAbrvChs> tag is supplied then the removal of existing and matching groups for the target profile is limited to just this list. This option allows us to avoid affecting a group not maintained by the external source performing this import. If this method is omitted then all groups for the target profile will first be removed when <GroupAbrvChs> is supplied.
RemovableSpecAbrvChs string list (comma delimited) If the <resource> section’s <GroupSpecAbrvChs> tag is supplied then the removal of existing and matching specialties for the target profile is limited to just this list. This option allows us to avoid affecting a specialty not maintained by the external source performing this import. If this method is omitted then all specialties for the target profile will first be removed when <GroupSpecAbrvChs> is supplied.
RemovableCanActAsAbrvChs string list (comma delimited) If the <resource> section’s <CanActAsAbrvChs> tag is supplied then the removal of existing and matching acting job titles for the target profile is limited to just this list. This option allows us to avoid affecting an acting job titles not maintained by the external source performing this import. If this method is omitted then all acting job titles for the target profile will first be removed when <CanActAsAbrvChs> is supplied.
InstitutionFocus string list(comma delimited) Not applicable in Person 02. If the <resource> section’s <InstitutionFocus> tag is supplied for Person 02 the system will not process the tag.

Rows

The following is the list of fields that are included for each <Row> in the <Rows> section.

Note:

Non-key field names are optional. If supplied, the corresponding field(s) of this application will be updated.

Lay term Format DB Column Name Field Name
First name max 40 characters RscMaster_FName_Ch FirstName
Middle name 1 character RscMaster_MName_Ch MI
Last name max 40 characters RscMaster_LName_Ch LastName
From date date RscMaster_From_Da RscMasterFromDa
Through date date RscMaster_Thru_Da RscMasterThruDa
1st contact method max 50 characters RscMaster_Contact1_Ch Contact1
2nd contact method max 50 characters RscMaster_Contact2_Ch Contact2
3rd contact method max 50 characters RscMaster_Contact3_Ch Contact3
4th contact method max 50 characters RscMaster_Contact4_Ch Contact4
Override on duty phone flag Y or N RscMaster_PhnOverride_Si OverrideOnDutyPhones
Address line one max 40 characters RscMaster_Address1_Vc Address1
Address line two max 40 characters RscMaster_Address2_Vc Address2
City max 40 characters RscMaster_City_Vc City
State abbrev. 2 characters RscMaster_State_Ch State
Zip code max 20 characters RscMaster_Zip_Ch Zip
Spouse name max 40 characters RscMaster_Spouse_Ch Spouse
Employee Identifier max 30 characters One of these and based on ImportKey method selection:
  • RscMaster_PayrollID_Ch (default)
  • RscMaster_EmployeeID_Ch
  • RscMaster_ExternalID_Ch
 One of these and based on ImortKey Method selection:
  • RscMasterPayrollIDCh (default)
  • RscMasterEmployeeIDCh
  • RscMasterExternalIDCh
Badge ID max 30 characters RscMasterBadgeID_Ch BadgeID
Race code 1 character RscMaster_Race_Ti RaceCode
Gender code 1 character RscMaster_Sex_Ti GenderCode
Birthdate mm/dd/yyyy RscMaster_Birthdate_Da Birthdate
Login account name max 40 characters RscMaster_Login_Name_Ch RscMasterLoginNameCh
Retired Y or N RscMaster_Disable_Si Retired; Inactivates the person.
Institution abbrev. max 10 characters Institution_Abrv_Ch Institution
Scheduled into institution(s) string list (comma delimitted) Institution_Abrv_Ch ScheduledInstitutionAbrvChs
Focus filters numeric (powers of two) Setup_Filters_In SetupFiltersIn
Base authority 1 number Auth_No_In BaseAuthority

Resources

Each <Row> can optionally have a <Resources> section where one or more <Resource> records can be supplied. The following is the list of fields that are included for each <Resource> in the <Resources> section.

Note:

Non-key field names are optional. If supplied, the corresponding field(s) of this application will be updated.

Lay term Format DB Column Name Field Name
Target date date   TargetDate
External ID Max 30 characters Rsc_ExternalID_Ch RscExternalIDCh
From date date Rsc_From_Da RscMasterFromDa
Through date date Rsc_Thru_Da RscMasterThruDa
Job title max 10 characters Job_Abrv_Ch JobAbrvCh
Specialty abbreviation(s) string list (comma delimited) Spec_Abrv_Ch SpecAbrvChs
Can Act As abbreviation(s) string list (comma delimited) Job_Abrv_Ch CanActAsAbrvsChs
Group abbreviation(s) string list (comma delimited) Group_Abrv_Ch GroupAbrvsChs
Promotion date date Rsc_Promotion_Dt RscPromotionDt
Special date date Rsc_Hire_Dt RscHireDt
UDF
  • String
  • Date
  • Boolean
  • Number
 UDF_Rsc_Values_Table The name of the UDF field must match the name of the UDF as shown in the database; if a non-matching name is provided, it will result in an error

The values are as follows:

String types are strings

Date types are a date, which is required to match the format of a date in the current locale, so for our standard users this would be MM/dd/yyyy

Numbers must be parseable to a double

Booleans must be parseable to true or false

If you provide the ListOfUDFs tag with no contents, such as <ListOfUDFs />, it will clear out all UDF fields for the profile

Row Attributes

The following optional attributes can be supplied with the <Row> tag to override the default behavior of the import process. For example, you can ensure that only an update is performed on a given row and that a failure will not stop the process by starting the row section with <Row Action=”Update” Optional=”True”>.

Name Format Description
Action One of...
  • Insert
  • Update
  • Remove
 The default behavior seeks to UPDATE if a match record is found and INSERT if an existing record is not found. This attribute allows you to specify how this individual row is treated.
Optional True or False (default) If TRUE, then match failures will be overlooked. For example, a record designated with <Row Action=”Update” Optional=”True”> indicates that you want to update if a match is found but that you don’t want to fail if a match is not found.
Clone True or False (default) If True, the entire Profile is copied. For example: <Row Action=”Insert” Clone=”True” Optional=”True”>
Notable Import Behaviors
  • If a field name (i.e. xml tag) is supplied then the target information will be updated in the application. For example, field names supplied with empty values will clear the target field in the application.
  • If institution focus is enabled then you can set the Institution tab information for a person. the <ScheduledInstitutionAbrvChs> field name can be provided to indicate which institutions this person can be scheduled into . If supplied then it will override the default behavior where <ScheduledIsntitutionAbrvChs> and <InstitutionAbrvCh> are maintained as identical.
  • <Row> Matches:The importKey in the <Methods> section identifies the field name (key) that will be used to find the target person in the application. If the importKey is omitted then the <rscMasterPayrollIDCh> field is used and required. If a person with the provided ImportKey is not found in the application, the person will be created. If a person with the provided ImportKey is found, that person will be updated. This means that the ImportKey field can only be used for matching and cannot be used to update the corresponding field in the application.
  • <Resource> Matches: If <TargetDate> is supplied then it will be used to find the active resource for the given target date. If <TargetDate> is omitted then <RscExternalIDCh>, if supplied, becomes a key to find the target profile. If neither <TargetDate> or <RscExternalIDCh> is supplied then <TargetDate> will be assumed to be today's date. If both <TargetDate> and <RscExternalIDCh> are supplied then the import behavior is to update <RscExternalIDCh> for the active profile on the <TargetDate>.<Resource> Matches: If <TargetDate> is supplied then it will be used to find the active resource for the given target date. If <TargetDate> is omitted then <RscExternalIDCh>, if supplied, becomes a key to find the target profile. If neither <TargetDate> or <RscExternalIDCh> is supplied then <TargetDate> will be assumed to be today's date. If both <TargetDate> and <RscExternalIDCh> are supplied then the import behavior is to update <RscExternalIDCh> for the active profile on the <TargetDate>.
Parent topic: About Ongoing Imports
1 The DB Column Name “Authority_No_In” (Base Authority) will automatically populate the lowest authority level if none is provided when Action=INSERT.