Location Import File Specification
Use this specification when uploading locations from the Locations grid using the Import Locations action.
File format
- File type: CSV (
.csv). - Header row: Required. Column names can use any of the aliases listed below. Matching is case-insensitive.
- Row order: Columns can appear in any order.
- Extra columns: Any columns not defined below will be ignored.
- Encoding: UTF-8 is recommended.
Column definitions
| Column header | Data type | Required | Accepted aliases | Description |
|---|---|---|---|---|
Name |
Text | Yes | LocationName, Location |
Full location name. |
Label |
Text | No | DisplayLabel, ShortName |
Short label for displays. Should be unique. If not specified, the system will generate a unique acronym based on the Name column. |
ExternalId |
Integer | No | BuildingId, ExternalIdentifier |
External identifier for payroll system when applicable. Currently only applicable for CSIU/FIS clients. |
PrimaryContact |
Text | No | Contact, ContactName |
Name of the primary contact for the location. Defaults to empty string. |
PhoneNumber |
Text | No | Phone, Phone Number, Phone_Number |
Contact phone number. Defaults to empty string. |
AddressStreet |
Text | Yes | Street, AddressStreet, Address Street |
Street address line. |
AddressCity |
Text | Yes | City, AddressCity, Address City |
City. |
AddressState |
Text | Yes | State, AddressState, Address State |
State or province. |
AddressPostalCode |
Text | Yes | PostalCode, Zip, ZipCode, AddressPostalCode, Address Zip |
Postal or ZIP code. |
Notes
- The Location import process is "add-only". If a location included in the file matches an existing "Label" or "ExternalId", it will be quietly ignored. Only the new locations will be imported.
- The address should be the physical address where substitutes are expected to report.
- The
ExternalIdcolumn is only applicable for certain clients. If you are unsure whether to include it, please consult your system administrator. - The
Labelvalues should be unique to avoid confusion in display and notifications. However, it can be updated at any time after importing.
Example CSV
Name,Label,PrimaryContact,PhoneNumber,ExternalId,AddressStreet,AddressCity,AddressState,AddressPostalCode
Central School,CS,Jane Smith,555-1234,42,100 Main St,Centerville,CA,90210