The Person 01 is used to automate a regular feed from an external source to import people records into this application. The Person 01 populates fields located in the General 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.
Person01-insert.xml Sample
<Data>
<Header>
<ImportDirective>PERSON01</ImportDirective>
<Methods>
<ImportKey>PayrollID</ImportKey>
<AssertBlankInfo VarType="11">False</AssertBlankInfo>
<InsertPerson VarType="11">True</InsertPerson>
<UpdatePerson VarType="11">True</UpdatePerson>
</Methods>
</Header>
<Rows>
<Row Action="Insert" >
<FirstName>JANE</FirstName>
<LastName>DOE</LastName>
<Contact1>*714-318-7273</Contact1>
<Contact2>*800-850-7374</Contact2>
<OverrideOnDutyPhones>N</OverrideOnDutyPhones>
<Address1>529 Winston</Address1>
<City>Bradbury</City>
<State>Ca</State>
<Zip>92606</Zip>
<Spouse>Anyone</Spouse>
<EmployeeID>18159</EmployeeID>
<PayrollID>99-18159</PayrollID>
<ExternalID>98-18159</ExternalID>
<RaceCode>C</RaceCode>
<GenderCode>M</GenderCode>
<Birthdate>1960-01-01</Birthdate>
<BaseAuthority>8</BaseAuthority>
<LoginID>18159</LoginID>
<DisableLogin>N</DisableLogin>
<Retired>N</Retired>
<Institution>1</Institution>
</Row>
</Rows>
</Data>Person01-update.xml Sample
<Data>
<Header>
<ImportDirective>PERSON01</ImportDirective>
<Methods>
<ImportKey>PayrollID</ImportKey>
<AssertBlankInfo VarType="11">False</AssertBlankInfo>
<InsertPerson VarType="11">False</InsertPerson>
<UpdatePerson VarType="11">True</UpdatePerson>
</Methods>
</Header>
<Rows>
<Row Action="Update" >
<Contact1>1234567890</Contact1>
<PayrollID>2000161</PayrollID>
</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...
|
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. |
| AssertBlankInfo | True or False (default) | If FALSE, blank values will not result in clearing the corresponding Workforce Information. If TRUE, the corresponding values within the application will be cleared. |
| InsertPerson | True (default) or False | If TRUE, it is okay to insert new person records into the application. |
| UpdatePerson | True (default) or False | If TRUE, it is okay to update existing person records within the application. |
Rows
The following is the list of fields that are included for each <Row> in the <Rows> section.
| Lay term | Format | DB Column Name | Field Name |
|---|---|---|---|
| Conditions | max 500 characters | RscMaster_Conditions_Dc | Conditions |
| First name | max 20 characters | RscMaster_FName_Ch | FirstName |
| Middle name | 1 character | RscMaster_MName_Ch | MI |
| Last name | max 20 characters | RscMaster_LName_Ch | LastName |
| 1st contact method | max 50 characters | RscMaster_Contact1_Ch | Contact1 |
| 2nd contact method | max 50 characters | RscMaster_Contact2_Ch | Contact2 |
| 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:
|
PayrollID (default), |
| Race code | 1 character | RscMaster_Race_Ti | RaceCode |
| Gender code | 1 character | RscMaster_Sex_Ti | GenderCode |
| Birthdate | mm/dd/yyyy | RscMaster_Birthdate_Da | Birthdate |
| Base authority 1 | number | Auth_No_in | BaseAuthority |
| Login account name | max 40 characters | RscMaster_Login_Name_Ch | LoginID |
| Disable user’s ability to login | Y or N | RscMaster_Login_Disable_Si | Disables the person’s login credentials. |
| Retired | Y or N | RscMaster_Disable_Si | Retired; Inactivates the person. |
| Institution abbrev. | max 10 characters | Institution_Abrv_Ch | Institution |
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...
|
The default behavior seeks to update 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 Auction=”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. |