This page reviews Facilities Checkout Center import files. These import files can be used to create and update existing Facilities Checkout Center, Facilities Locations, Hooks, Location Access Hooks, Location Assignments, and Keys. The Facilities Application is available as of the July 2021 version.

The Facilities Checkout Center must be created via the import file. Please contact support@webcheckout.net with any questions.

Review how to import for an overview.

Download Template CSV Import Files

To download template files, please click link below. Template files contain default import fields only.

  • FACILITIES-CENTER-IMPORT: Required to create the Facilities Checkout Center. Only those with an Enterprise License can create a Facilities Checkout Center. Please contact support@webcheckout.net with questions.
  • LOCATION-IMPORT: Creates physical locations that keys unlock. Facilities Locations are different from circulating resources of metaclass “Location” in WebCheckout.
  • HOOK-IMPORT: Creates hook information to denote a collection of keys all cut the same way, and associated with locations or equipment locks they will unlock. Similar to a Resource Type, or category of items, all keys must be assigned to a key hook.
  • LOCATION-ACCESS-HOOK-IMPORT: A location import file that assigns hooks to the physical locations they unlock. Locations and hooks must already exist.
  • LOCATION-ASSIGNMENT-IMPORT: Assigns Patrons to Facilities Locations, granting them permission to those location hooks. Patron and Location information must already exist.
  • KEY-IMPORT: Creates physical key records associated with their hooks. Hook information must already exist.
  • KEYING-IMPORT: Imports historical key history of a hook. If a hook is rekeyed this import allows importing that record.

Facilities Checkout Center Import Specifications

  • Download the Facilities Center Import file
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Facilities Checkout Center File Configuration Settings

The following table describes requirements for the Configuration Section of the Facilities Checkout Center import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Key-Center
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to Name
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Key Center Import Fields

Table describes default importable data. Column headers must not be renamed.

When creating a new Key Center, the following fields are required: NAME and ORGANIZATION.

Column header Definition
NAME Required. Text field. Key Checkout Center name.
ORGANIZATION Required. Text field. Syntax must match the Organization created in WebCheckout.

Location Import Specifications

Location represents any physical space door that has a lock and requires management of access through that lock. Facilities Locations are different from circulating resources of Metaclass “Location” in WebCheckout.

  • Download the LOCATION-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Location File Configuration Settings

The following table describes requirements for the Configuration Section of the Location import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Location
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to Location-Code.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Location Import Fields

Table describes default importable data. Column headers must not be renamed.

Any non-required and unused columns can be deleted from the import file, or if the header is included and data is not being added or edited, add the header name to the NONIMPORT_COLUMNS field of the Configuration Section.

Column header Definition
LOCATION-CODE Required. Text field. Unique identifier and primary key.
NAME Require. Text field. Name of Location.
LOCATION-TYPE Required. Denotes the type of physical location. Accepted values: Area, Building, Floor, Hall, Suite, Room, Space, Door, Closet, Desk, Cabinet, Shelf, Other.
ORGANIZATION Required. Organization name of the Facilities Checkout Center as it appears in WebCheckout.
SHORT-NAME Text field. Location short name.
PARENT-LOCATION Text field. Accepted value: Location-Code of the parent Location. Parent Location must be listed or created before the child Location. Create parent-child relationship.
LOCK-TYPE Text field. Accepted value:  Master, No Master, None. Denotes the type of lock at the location entrance.
STREET Text field. Location address.
STREET2
 Text field. Location address.
STATE Text field. Location state.
POSTAL-CODE Text field. Location zipcode.
COUNTRY Text field. Location country.
TELEPHONE Text field. Location phone number.
CITY Text field. Location city.
LONGITUDE Float (integer) field. Location longitude.
LATITUDE Float (integer) field. Location latitude.
NOTES Text field. Notes about the Location.

Hook Import Specifications

Key Hooks (or hook for short) is a record that represents the collection of keys that are all cut the same way and associated with locations or equipment locks they will unlock. Similar to a Resource Type, or category of items, in WebCheckout.

  • Download the HOOK-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Hook File Configuration Settings

The following table describes requirements for the Configuration Section of the Hook import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Key-Hook
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to Resource-Type-ID.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Hook Import Fields

Table describes default importable data. Column headers must not be renamed.

Any non-required and unused columns can be deleted from the import file, or if the header is included and data is not being added or edited, add the header name to the NON-IMPORT field of the Configuration Section.

Column header Definition
RESOURCE-TYPE-ID Required. Text field. Unique identifier of the hook and only visible in WebCheckout Admin interface.
ORGANZIATION Required. Text field. Organization name of the Facilities Checkout Center as it appears in WebCheckout.
NAME Required. Text field. Hook friendly name.
HOOK-NUMBER Text field. Numerical value of Hook.
LOCK-TYPE Text field. Accepted values: Cylindrical, Mortise, Removable, Rim, Other.
KEYWAY Text field. Seen from the vertical profile of a key. Typically unique per lock manufacturer. For example, a ‘Baldwin’ key will not fit a ‘Kwikset’ lock.
KEYCUT Text field. Seen from the horizontal profile of a key. Defined by the peaks and valleys cut into a blank key that activate a lock’s tumblers.
MASTER
 Text field. References the RESOURCE-TYPE-ID of master hook. This determines the relationship between different key hooks in a hierarchy.
CHANGE-LOCATIONS Text field. LOCATION-CODE of related Change Location Hook unlocks.
EQUIPMENT-CODE Text field. Code of Equipment Hook unlocks.

Location Access Hook Specifications

Location Access Hook is a Location import file that  links Key Hooks to the Locations they unlock.

  • Download the LOCATION-ACCESS-HOOK-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Location Access Hook Configuration Settings

The following table describes requirements for the Configuration Section of the Location Access Hook import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Location
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to LOCATION-CODE.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Location Access Hook Import Fields

Table describes default importable data. Column headers must not be renamed.

Column header Definition
NAME Required. Text field. Name of Location.
LOCATION-CODE Required. Text field. Unique identifier and primary key of Location. .
ORGANIZATION Required. Organization name of the Facilities Checkout Center as it appears in WebCheckout.
ACCESS-HOOK Text field. Hook Resource-Type-ID. If multiple Hooks associated with a location, separate using the pipe (|) character.
LOCATION-TYPE Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Location Assignment Import Specifications

Location Assignment Assigns Patrons to locations, granting them permission to those location hooks. Patron and Location information must already exist.

  • Download the LOCATION-ASSIGNMENT-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Location Assignment File Configuration Settings

The following table describes requirements for the Configuration Section of the Location Assignment import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Location-Assignment
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to Assignment-ID.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Location Assignment Import Fields

Table describes default importable data. Column headers must not be renamed.

Any non-required and unused columns can be deleted from the import file, or if the header is included and data is not being added or edited, add the header name to the NONIMPORT_COLUMN field of the Configuration Section.

Column header Definition
Assignment-ID Required. Text field. Unique-ID of Location Assignment.
Location Required. Text field. LOCATION-CODE of Location assigned to Patron. Location record must already exist in the application.
PERSON Required. USER-ID of Patron assigned to Location. Patron record must already exist in the application.
START-TIME Accepted values include date/time. Date must be formatted to based on your Global Local. For example: mm/dd/yyyy or yyyy-mm-dd.   No Start Date AND no End Date indicates the Access is Active.
EXPECTED-END Text field. Time Stamp formatted as mm/dd/yyyy or yyyy-mm-dd.
ACTUAL-END Text field. Time Stamp formatted as mm/dd/yyyy or yyyy-mm-dd.
DESCRIPTION Text field. Description.
NOTES Text field. Notes.
Sequence
 Text field. Sequence

Key Import Specifications

Keys are a single, serialized resource capable of unlocking a location or a lock to a piece of equipment.

  • Download the KEY-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Key File Configuration Settings

The following table describes requirements for the Configuration Section of the Key import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to Key
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to LABEL-ID.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Key Import Fields

Table describes default importable data. Column headers must not be renamed.

Any non-required and unused columns can be deleted from the import file, or if the header is included and data is not being added or edited, add the header name to the NON-IMPORT field of the Configuration Section.

Column header Definition
LABEL-ID Required. Text field. Name of Key Resource and must be unique.
KEY-Center Require. Name of Facilities Checkout Center as it appears in WebCheckout.
Sequence-ID Required. Text Field. Key Sequence.
KEY-HOOK Required. Hook Resource-Type-ID. Hook record must already exist in the application.

Keying Import Specifications

Import historical key history of a hook. If a hook is re-keyed this import allows importing that record.

  • Download the KEYING-IMPORT file.
  • Files must be saved as .csv with UTF-8 encoding. We recommend using LibreOffice. When using Excel, first save the file as a .csv with UTF-8 encoding, then open in TextEdit and save before importing.
  • Configuration and Data sections are required.
  • Column header syntax must be referenced in the import file exactly as listed below.

Keying File Configuration Settings

The following table describes requirements for the Configuration Section of the Keying import file.

Any non-required row, if not being used, can be deleted from the Configuration Section.

Row header Definition
VERSION Required. Must be set to 2.
 TYPE Required. Must be set to KEYING
 LABEL Text field to include information about the import. This row is not required and can be omitted.
 LOOKUP_COLUMNS Required. Must be set to HOOK and DATE-PINNED.
 IMPORT_COLUMNS Required to update or create new data. Import Columns specify columns that will be updated via import. All columns are required when creating new records.
 NONIMPORT_COLUMNS Required only if columns included in the Data section are not included in IMPORT_COLUMNS. This row allows columns to be excluded from the import.

Keying Import Fields

Table describes default importable data. Column headers must not be renamed.

Any non-required and unused columns can be deleted from the import file, or if the header is included and data is not being added or edited, add the header name to the NON-IMPORT field of the Configuration Section.

Column header Definition
HOOK Required. Must be used as the Lookup Column. Hook RESOURCE-TYPE-ID.
DATE-PINNED Require. Date of Hook’s KEYCUT and KEYWAY creation or change. Time Stamp formatted as mm/dd/yyyy or yyyy-mm-dd
KEYCUT Required. Text field. Seen from the horizontal profile of a key. Defined by the peaks and valleys cut into a blank key that activate a lock’s tumblers.
KEYWAY Required. Text field. Seen from the vertical profile of a key. Typically unique per lock manufacturer. For example, a ‘Baldwin’ key won’t fit a ‘Kwikset’ lock.
OUT-OF-SERVICE-DATE Required. Date of KEYCUT going Out-of-service due to rekeying.

See Also