SIMS 7 - HR Assistant File Template

Specification for Data exchange with HR Assistant

HR Assistant can accept files that are either pipe (vertical bar) delimited or XML.  TI's wishing to use this system would decide which of the two supported formats they wish to provide.  The associated HR Assistant licence file then defines the agreed structure for the data exchange.

Lookups

Where marked below and included in the data file, Lookup values must match those in SIMS for the receiving school. Actual values can vary between school and may need to meet government code sets for items such as ethnicity where exchanged.

Field Selection

Some fields are mandatory, others are optional as shown in the table below

For Pipe Delimited files please specify the column number (0 based), fields must be in the correct column order with no gaps.  XML accepts fields in any order but requires that TIs indicate whether the optional fields are in scope for their system.  This is important because there is a field that is excluded from transfer will not be updated whereas a missing or null value from an included field will delete the value in SIMS. 

Example 1.  [Not a full set]

System A provides Pipe delimited files as follows:

• Smith|John|Male
• <Legal Surname>|<Forename>|<Gender>

We would need the table filled in as follows.

System 2.  [Not a full set]

This provides the same via XML for example

<Staff>
  <StaffMember Name="Blacker,Adrian">
    <LegalForename>Adrian</LegalForename>
    <LegalSurname>Blacker</LegalSurname>
    <Gender>Male</Gender>
    ...
  </StaffMember>
  ...

then we need the table filled in as follows.

Available Fields

Guidance

Files must contain a complete set of staff that need to be in SIMS.  If a member of staff is unpaid or non-contracted in some way and need to be in SIMS then they must also be in the HR system and included in the file.