To create a hierarchy structure in Passport, upload four files in this order: Facility file, Unit file, Node Hierarchy file, and User file. The Node Hierarchy file organizes facilities and nodes into a pyramid structure using three node types: Network (highest level), Facility (individual units), and Named (custom groupings). Node Integration IDs and Parent Node data are essential for linking nodes. After uploading a Node Hierarchy file, re-upload a User file to apply changes. Modifications replace old nodes; omitting nodes removes them from the hierarchy. Adhere to capitalization rules for unique IDs.
The following article outlines the file and specifications for creating a hierarchy structure within your organization.
Four files are required to create a hierarchy structure, and they must be uploaded in this order:
- Facility file
- Unit file
- Node Hierarchy file (see sample template at bottom of this web page)
- User file
The node hierarchy file will allow you to string facilities together into a hierarchy or pyramid so you can them under other parent facilities and visually represent your organization's structure within the application. We refer to our structure in nodes that roll into parent nodes.
There are currently 3 Node Types supported in Passport.
1. Network
2. Facility
3. Named
A Network node is the highest point in your organization or network. This is, essentially, your whole company defined in our system. Each client has one unique ID that is set by Passport to represent your unique network.
A Facility node references a facility that you've already setup within your organization or network. You may have facilities setup to represent true brick and mortar buildings or you may have chosen a more abstract concept for your Passport facilities like "Employees" and "Contractors".
A Named node is the most flexible and allows you to set up a specific name or title to reference an area or region in a way that's significant to you. You don't have to have a facility named "West Region" in order to organize facilities under it. Simply indicate a Parent Named node as that title, and then you can string facilities or other Named nodes underneath it.
The following identifies all required and optional fields from the file. The header row must stay intact exactly as provided in the Sample File. Row 2 must include a reference to the topmost Network node for your company so there is an official single highest point. In this second row, the node type will be "Network" and the Node Integration ID will be the unique ID for your organization. This ID can be found when you login to Passport, and navigate to the Integration Tab -> Integration Mappings -> Organization ID. There will be no Parent Node or Parent Node Integration ID for this row.
All other details of the hierarchy effectively begin on row 3. The first two columns of data refer to the "child" node or lower point, with the third and fourth columns referring to that child node's "parent". You cannot have a Node Type without a Node Integration ID or vice versa. You cannot have a Parent Node Type without a Parent Node Integration ID or vice versa. These nodes are set up both by Type and ID.
Please follow the directions before for the content of each column beginning on row 3.
Please note: After a new node hierarchy file has been uploaded, a new user file MUST be uploaded in order for the updates to be visible. Each time a node hierarchy file is uploaded, a new hierarchy is created and will remove or update any old nodes that are no longer needed. If you need to remove facilities from a hierarchy view, simply upload a new node hierarchy file (without the facilities you want to delete), then upload a new user file.
| Column | Notes |
| Node Type |
Required:
The three accepted Node Types are "Facility", "Named", and "Network" (Network is only used in row 2). After setting up the highest Network node you can string up child nodes that are either a Facility in your Organization or a newly defined Named title grouping.
(Ex. Network, Facility, Named) |
| Node Integration ID |
Required: Node Integration ID is the unique ID assigned to the node itself.
Capitalization must remain the same throughout the file. For example: WEST represents a different named node than West.
|
| Parent Node Type |
Optional: If no Parent Node Type is set up, the node will default to being below the Network Node which is the highest point. If any lower level is being set up, then a Parent Node Type should be set up. The three accepted Node Types are "Facility", "Named", and "Network". This will define the parent or higher rolled up node for what was referenced on the same row in columns A and B. (Ex. Network, Facility, Named) |
| Parent Node Integration ID |
Optional: If there is a Parent Node Type setup, Parent Node Integration ID is required. This will define the parent or higher rolled up node for what was referenced on the same row in columns A and B.
Capitalization must remain the same throughout the file. For example: WEST represents a different named node than West.
|
Download the sample file below