hrLoadJob

Overview

The hrLoadJob processes .xml and .done files dropped into the staging/sys/hrLoad directory in order to update the Person table based on data from an institution's HR system. 

• If a record exists for the first time in the file, a new Person record is added. 
• If a record exists for an existing Person, the Person record is updated. 
• If a record no longer exists for an existing Person, the Person record is inactivated and any active Groups, Roles and Delegations Active To Date is set to the day the job is run.  Following are the exceptions to inactivation when a record doesn't exist in the file: 
  • Person records with Affiliation Type = AFLT,
  • Person records with Entity Type Code = SYSTEM, such as, kfs, kr and admin, 
  • Person records included in parameter PRINCIPAL_NAMES

Existence Checks

When determining if an existing record exists, there are a series of checks.

• If the principalName in the file exists in the existing system, but the principalId does not match between the two, the record is not added/updated, and an error is recorded for that principalName
• If the principalId in the file does not exist in the existing system the following checks are made:
  • If the principalName exists in the existing system, the record is not added, and an error is recorded.
  • If an entityId is in the file, and that entityId exists in the existing system, the record is not added and an error is recorded.
  • If both of these checks are successful, then the record is added to the system.
• If the principalId in the file does exist in the existing system, the existing record is updated with the data in the file.

Reports

Directory	Name	Description
reports/sys	hrLoadJob_<dateTimestamp>.txt	Reports on the number of:  XML Records processed Inserted Principal count Updated Principal count Inactivated Principal count Unchanged Principal count  Any errors in processing - usually when there is a mismatch on principal name and ID in the file and the Person table.  Inserted + Updated + Inactivated = XML Record - Errors NOTE: A report will not be generated if there wasn't a file to process.
report/sys	hrLoadJob_<dateTimestamp>.log	Reports on the number of records processed and any errors encountered.  NOTE: If an empty file is loaded, the log will indicate that the file could not be parsed.

XML File Format

The XML schema (.xsd) is available online at https://github.com/KualiCo/ce-tech-docs/blob/master/v3_0/hrmanifest.xsd

NOTE: Tags/fields with minOccurs="0" are optional.

An example XML file follows:

<?xml version='1.0' encoding='UTF-8'?>
<hrmanifest xmlns="https://github.com/KualiCo/ce-tech-docs/tree/master/v3_0" schemaVersion="3.0" statusEmailRecipient="[e-mail]" recordCount="20594">
  <h:record xmlns:h="https://github.com/KualiCo/ce-tech-docs/tree/master/v3_0" entityId="KFS3776" principalId="6162502038" principalName="khuntley" active="true">
    <h:affiliationType>STAFF</h:affiliationType>
    <h:campus>BL</h:campus>
    <h:employeeStatus>A</h:employeeStatus>
    <h:employeeType>P</h:employeeType>
    <h:baseSalaryAmount>0.01</h:baseSalaryAmount>
    <h:primaryDepartment>UA-VPIT</h:primaryDepartment>
    <h:employeeId>0000202278</h:employeeId>
    <h:addressLine1>East Peltason Dr</h:addressLine1>
    <h:city>Irvine</h:city>
    <h:stateOrProvince>CA</h:stateOrProvince>
    <h:postalCode>92697</h:postalCode>
    <h:country>US</h:country>
    <h:firstName>Keisha</h:firstName>
    <h:lastName>Huntley</h:lastName>
    <h:phoneNumber>800-555-1212</h:phoneNumber>
    <h:emailAddress>[e-mail]</h:emailAddress>
  </h:record>
</hrmanifest>