Generated Properties
When exporting a dataset via the Export API the exported data will also include both Orgvue Generated Properties and any Lookup Properties
Orgvue Generated Properties
Generated properties exist for all datasets within Orgvue. These properties follow a naming convention that begins with the underscore character.
While generated properties will exist for all datasets, some of the values are calculated based on the node's relationship to other nodes in the dataset.
These properties will only have meaning if the node relationship is hierarchical.
Flat and hierarchical datasets
There are two distinct types of node relationships that a dataset can have, flat or hierarchical. A flat relationship between nodes means that all of the nodes within the dataset have neither a parent nor any child nodes. A hierarchical relationship between nodes means that each node can have zero or one parent nodes as well as zero or more child nodes.
Several of the generated property descriptions refer to the concept of an organizational layer. Organizational layers are defined as the length of the path between a given node and the root node of the tree, plus one. Root nodes have an organizational layer value of 1, their children have a value of 2, and so on.
| Property | Description | Hierarchical Datasets Only |
|---|---|---|
_change | Flags if a node has changed since the last save (options: new,updated,deleted,none). The Export API will always return a value of none | No |
_has_unique_id | Boolean field indicating whether or not the node has a unique identifier. This property provides the inverse value of _is_duplicate | No |
_is_duplicate | Boolean field indicating whether or not the node has a non-unique identifier. This property provides the inverse value of _has_unique_id | No |
_is_ghost | Boolean field indicating whether or not the node is a ghost node. A ghost node is a node that exists in the dataset, but is hidden from the user by a filter or access controls | No |
_label | Returns the value of the property that is currently configured as the dataset label. | No |
_records | Has the value 1 for all nodes (it is used in charts to avoid splitting bars) | No |
_depth | Returns the organizational layer of the node in the hierarchy. Any node that does not have any ancestors will have a depth of 1 | Yes |
_descendants | Returns all of the node's direct ancestors | Yes |
_height | The number of organization layers below the node before any filters have been applied | Yes |
_is_leaf | Boolean field indicating whether or not the node has any children | Yes |
_is_orphan | Boolean field indicating whether or not the node has a parent | Yes |
_layers | The number of organization layers below the node after any filters have been applied | Yes |
_level_{n} | Returns the ancestor of the node at the specified depth (where n is an integer between 1 and the current node's depth) | Yes |
_outgoing_count | Returns the number of children the node has (regardless of filters) | Yes |
_span | Returns the number of children the node has after a filter has been applied. Treats leaf nodes as having a value of null rather than 0 | Yes |
_subtree | A sub-tree is a slice of a hierarchy that includes a parent and their descendants down 3 levels. | Yes |
These properties are not included in the default dataset export, but can be added to the response body using a projection.
| Property | Description | Hierarchical Datasets Only |
|---|---|---|
_id | A UUID that is automatically generated by orgvue for each node. The UUID is a 32 character string consisting of numbers and upper case letters separated by dashes, i.e. EDC19240-2738-DD6C-12AA-7932801D96FE. This property is used to ensure that nodes always have a unique value and is separate from the user selected dataset identifier property | No |
_modifiedat | Contains the last time that the node was changed given in ISO 8601 format | No |
For more information on Orgvue's generated properties please visit the Generated Properties section of the Gizmo Cookbook.
Lookup Properties
Properties in Orgvue datasets may be linked to Lookup Datasets. Lookups allow you to reference a central source of data that may change on a regular basis without having to change all the datasets using the lookup data
A common example would be an exchange rate table to provide currency conversion rates to all salaries entered in local currency, based on the currency property
Any lookup properties in the exported data will be shown with the naming convention {lookup property key}:{looked-up property} in the example of currency conversion this may be shown as Currency:Exchange Rate to GBP