Requirements for Region Data
- Last updated
- Save as PDF
General Information
Description – Regions enable the hierarchical grouping of buildings used for general navigation and reporting. The grouping can be any classification such as geography, market, or operation. A typical region hierarchy may be structured as follows: All, Continent, Country, State, and City. Each building is assigned to a single region.
Common Data Sources – The list may come from an existing system (such as an IWMS, CAFM, or HR system) or a manually prepared spreadsheet.
Recommended Refresh Frequency – Not applicable, the region hierarchy does not participate in an automated integration.
Custom Fields – Custom fields are not supported for regions. File Updates – Not applicable, updates are complete in manually in Serraview using the Regions keyword set.
Updates - Any updates are completed manually in Serraview using the Regions keyword set, refer to Modify the Regions Keyword.
Additional Information
- Each hierarchical level is called a node. Serraview supports unlimited nodes.
- Serraview supports a single tree hierarchy meaning that a building can only belong to one region at a time.
- Each building is assigned to the lowest level of a region hierarchy. A building cannot be assigned to the parent of a region.
- If you have a campus, it needs to be defined as a region.
- Not all branches of the hierarchy need to have the same number of nodes. For example, some branches may end with a campus as the lowest node, others may end with the city as the lowest node.
- The region hierarchy must be established and loaded prior to loading the building data.
The example below depicts one branch of a hierarchical tree for North America.
Region |
Parent Region |
Level (For Reference Only) |
---|---|---|
All Buildings |
Top-Level Region |
Level 0 |
Americas |
All Buildings |
Level 1 |
Canada | Americas | Level 2 |
United States |
Americas |
Level 2 |
Illinois |
United States |
Level 3 |
California |
United States |
Level 3 |
Chicago |
Illinois |
Level 4 |
San Francisco |
California |
Level 4 |
HQ Campus |
Chicago |
Level 5 |
Toronto | Canada | Level 3 |
Quebec | Canada | Level 3 |
Montreal | Canada | Level 3 |
Vancouver | Canada | Level 3 |
Region Import
The Region Import requires the following:
- Each row of the file must represent a single node.
- Each Parent Region must also be listed as a Region.
This file can be provided as a .CSV.
Data Dictionary
The table below lists the columns and the required columns and values are shown in blue text.
Column Name |
Description |
Data Type |
Max Length |
Column Required |
Value Required |
Unique in this file |
---|---|---|---|---|---|---|
Region Name |
The name of the region. All Parent Regions must first be listed as a Region. |
Text |
200 |
Yes |
Yes |
Yes |
Description |
The description of the region. |
Text |
500 |
Yes |
No |
No |
Parent Region |
The name of the region this region rolls up to. All Parent Regions must also be listed as a Region. All Regions must have a Parent Region except for the top Region. |
Text |
200 |
Yes |
Yes (The top region will not have a parent.) |
No |
Level |
The hierarchical level of the region. This value does not get loaded but is useful in reviewing and checking the structure. |
Text |
NA |
No |
No |
No |