Viewpoint Properties File Format
This topic describes the format of files used to load the configuration of properties displayed in a viewpoint. The viewpoint properties file must be an Excel file with a sheet named Properties.
Summary Sheet Format
| Field | Description |
|---|---|
| View Name | The name of the view that contains the viewpoint. This value is informational and cannot be modified. |
| Viewpoint Name | The name of the viewpoint. This value is informational and cannot be modified. |
| Node Type(s) | The node type or node types associated with the viewpoint. This value is informational and cannot be modified. |
| Default Property Group | The property group that is selected by default when viewing or
editing nodes in the viewpoint. You can modify this value before
uploading the workbook to change the viewpoint's default property
group.
Note: If the specified default property group does not exist or does not contain any properties, the default property group is set to All when the workbook is uploaded. |
Properties Sheet Format
Considerations
- All header records must be included in the file, in the order specified below.
- There must be a record in the file for each visible property in the viewpoint.
- If a property in the file is not a visible property for the viewpoint, the row is skipped.
- If there are multiple records for the property in the file, the first record in the file is processed. Any subsequent records are skipped and marked with a skipped status and a corresponding message.
Header Columns
| Field | Description |
|---|---|
| Property (Required) | The fully qualified name of the property (for example,
CoreStats.Parent).
|
| Label | The custom label for the property in the viewpoint. |
| Description | The custom description for the property. |
| Property Groups (Required) | The property groups to associate the property with. See Creating, Editing, and Deleting Property Groups.
Note: If the property group exists, the system adds a property association to that group. If the property group does not exist, the system creates it and then adds the property association to that group. |
| Display as Column | A Boolean value (TRUE or FALSE) that specifies whether the property is displayed as a column in the viewpoint. See Configuring How a Viewpoint Displays Properties. |
| Display for Locations | A Boolean value (TRUE or FALSE) that specifies whether the property is displayed on the Locations tab in the viewpoint. See Configuring Locations Tab Properties. |
Status Columns
| Field | Description |
|---|---|
| Status | System reserved column that displays the status of the property (Success or Skipped) after you upload it. |
| Message | System reserved column that displays an informational message on properties that were skipped. |