Property Manager

The Manager screen lists all properties in a selected dataset

From the Property Manager it is possible to:

Property List

To access the Property Manager screen either:

Once opened the Property Manager shows:

image

  • A. All the properties present in the dataset along with details of:
    • Property Name
    • Property Key
    • Property Type
    • Property Tags: See Tags for more details
    • Property Aliases
    • Property Required Y/N
  • B. Each column can be used to sort the data in ascending or descending order using the up/down
  • C. Properties displayed in columns can also be filtered using the Filter button
  • D. Selecting the more details ellipsis button will open the Property Menu
  • E. Property Reorder button

Add Property

It is possible to add a property to an existing dataset from the Property Manager screen

image

To do this:

  1. Select the + Add Property button
  2. This will open the edit properties panel for the new Property

Where you can enter the following details:

  • A. Display Name*
  • B. Property Key*
  • C. Property Type*
  • D. Alternative Keys
  • E. Property tags – free text field to enter any Property tags

*Mandatory field

If Number, Date or Boolean Property types are selected in C' then additional selections can be made to format the Property

Edit Property

Existing properties may be entered by either:

  • A. Selecting the checkbox for required Property and then the Edit button
  • B. Selecting the ellipsis menu icon for the required Property and then choosing Edit

image

This will open the Edit Properties Window containing three tabs

image

Property Tab

The property tab contains the following fields:

  1. Display Name*
  2. Key* (Non amendable)
  3. Type*
  4. Alternative Keys
  5. Tags – free text field to enter any Property tags. See Tags and Property Tags for more details

*Required field

Alternative Property Keys

An alternative property key or property alias allows the addition of a second property key for use in Gizmo Expressions this is often useful if the property key contains more than one word to make writing expressions simpler

In addition alternative property keys will be automatically assigned to some properties when the dataset is used with a Template Pack

image

Property Tags

Property tags are available to provide specific functions within Orgvue or free text tags may be used to sort or categorize properties

To tag a property, edit the property by either:

  • A. Selecting the checkbox for required Property and then the Edit button
  • B. Selecting the ellipsis menu icon for the required Property and then choosing Edit

image

This will open the Edit Property side panel

Enter the required Tag and then Save

image

Values Tab

Choose how values are populated and displayed

The value tab contains:

image

  1. Expression
  2. Input Options * Text properties only
  3. Required Property
  4. Display Formatting : Values
  5. Buckets * Number properties only

Input Options

The inputs options are displayed if the Provide users with a set of values checkbox is selected

It provides the ability to choose where Orgvue should provide input values from

image

Either:

  • A. State what values users can enter by entering values into the Drop-down list box and pressing Enter for each option to include a line break
  • B. Provide values from a Lookup Dataset(Manual)
  • C. Provide values from a Lookup Dataset(Auto)

Required Property

Selecting the Required checkbox will mark the property as a required one when creating new nodes

Values

The values section details how the property will be displayed

Text Format

For Text type properties it is possible to set the format to be displayed within orgvue as either

image

  1. Single-line Text
  2. Multi-line Text

Date Format

For Date type properties there are multiple options to set how the date will be displayed in orgvue

image

The table below provides the output shown in Workspace for each date format option for both Locale Options

Each example is based on the input date Wednesday 12 October 2022

Format Output English (UK) Output English (US)
Day( dd ) 12 12
Day ( E ) Wed Wed
Day ( EEEE ) Wednesday Wednesday
Month (MM) 10 10
Month (MMM) Oct Oct
Month (MMMM) October October
Year (yy) 22 22
Year (yyyy) 2022 2022
Month Year (MMM-yy) Oct-22 Oct-22
Date (Short) 12/10/22 10/12/22
Date (dd MMM yyyy) 12 Oct 2022 Oct 12, 2022
Date (dd MMMM yyyy) 12 October 2022 October 12, 2022

Boolean Format

For Boolean type properties there are 3 display options

image

  1. 1 /0
  2. True / False
  3. Yes / No

Number Format

For Number type properties it is possible to set the format for the number to be displayed within Orgvue by

image

  1. Select Values within Display Formatting
  2. Format: Use the Dropdown list to select required number format
  3. Places: Used in conjunction with format to define the number of decimal places displayed

Note: Places only applies to displayed values any decimal places will still be shown in Gizmo expressions

Number Buckets

Number buckets define how data will be grouped when viewed on filter panels and visualizations

image

Choose from

  • A. Based on matching values
  • B. Buckets with equal amounts of nodes. Select the number of buckets
  • C. Create your own buckets. Define buckets parameters

Permissions Tab

The permissions tab allows the setting of what role groups can access this property and how they can interact with it

There are 4 levels of permissions that may be applied to properties

image

  1. Hidden: Cant see the property
  2. Read Only: Can see the values
  3. Update: Can edit the values
  4. Modify: Can edit the settings

Permissions are applied by entering a role group into the permission level box

See Property Permissions for more details

Date Format

For Date type properties there are multiple options to set how the date will be displayed in orgvue

image

The table below provides the output shown in Workspace for each date format option for both Locale Options

Each example is based on the input date Wednesday 12 October 2022

Format Output English (UK) Output English (US)
Day( dd ) 12 12
Day ( E ) Wed Wed
Day ( EEEE ) Wednesday Wednesday
Month (MM) 10 10
Month (MMM) Oct Oct
Month (MMMM) October October
Year (yy) 22 22
Year (yyyy) 2022 2022
Month Year (MMM-yy) Oct-22 Oct-22
Date (Short) 12/10/22 10/12/22
Date (dd MMM yyyy) 12 Oct 2022 Oct 12, 2022
Date (dd MMMM yyyy) 12 October 2022 October 12, 2022

Duplicate Property

It is possible to duplicate another Property within your dataset and this may often be easier than adding a Property, if formats & details are similar

Existing properties may be duplicated by either:

image

  • A. Selecting the checkbox for Property to be duplicated and then the Duplicate button
  • B. Selecting the ellipsis menu icon for the required Property and then choosing Duplicate
  • C. Selecting the Duplicate icon for the required property on the Edit Property window

This will open the edit details side panel for the duplicated Property where you can enter or edit the following details:

image

  1. Display Name: This will default to Duplicated Property name - (copy) but can be amended
  2. Key will default to Duplicated Property name - (copy) but can be amended
  3. Property Type
  4. Alternative Keys
  5. Property tags
  6. Values
  7. Permissions Tab

Delete Property

To delete a Property either:

image

  • A. Select the checkbox for required Property and then the Delete button
  • B. Select the ellipsis menu icon for the required Property and then choosing Delete
  • C. Selecting the Delete button for the required property on the Edit Property window

Confirm that you wish to delete the Property by selecting Yes on the confirmation message that is displayed

image

Reorder Properties

Properties will appear on the Property Manager screen in the order that they appeared on the source file

If you have expression properties in your dataset they will calculate in the order they appear in the Property Manager

The Property order will also be reflected when adding a node or downloading a dataset

To change the order of properties either via the property list

image

  1. Select Reorder on the Property List screen
  2. This will open the Reordering Properties window
  3. Using the 6 dots icon, drag and drop the properties to the desired Property order

or from within the Edit Properties window by dragging and dropping the properties to rearrange

gif

Expression Properties

When adding new properties or editing existing properties, it is possible to include expressions to create calculated properties to populate values

This may range from simple mathematical calculations that add two properties together to provide a sum, through to more complex logic based transformations of data

Expressions in Orgvue are written in Gizmo. It is a scripting language that has its roots in JavaScript but has been added to and modified by the Orgvue development team

For further detail on Gizmo expressions see the Gizmo Cookbook

image

To populate property values using an expression, first follow the steps to either Add a New Property or Edit an existing property

  1. Select the Values Tab
  2. Select the Populate values using an expression checkbox
  3. Enter the Gizmo Expression into the expression window
  4. Select the required Property expression mode
  5. Select the required Property evaluation mode
  6. Select Save

Property Expression Mode

The expression mode determines when a Gizmo expression will be run for the property value for a node

Expression Mode Behavior
Empty Cells If the cell has no value, populate the data with the value returned from the expression
New Nodes When a new node is created, populate the cell with the value returned by the expression
The expression will only run on the creation of a node unless triggered via On Demand
All Nodes The expression will be evaluated for all Nodes, regardless of whether a Cell stores a value of not. The Cells are not editable within Workspace

Property Evaluation Mode

The Evaluation mode determines how the expression will work

Evaluation Mode Behavior
None The Expression will be treated as a literal value, returned as entered in the Expression box
Pre-filter The expression will ignore any Filtering or Paging that is applied. The expression will be re-evaluated whenever data are edited
Post-filter The expression results depend on any active Filters and evaluation occurs whenever data are edited or when the Filter is changed
You cannot Filter or Page on a Post-Filter (or Hierarchy) evaluated Property
On Demand The expression will be evaluated when you activate it in Workspace, and not automatically following edits
The return value of the expression will be saved to the Cell. An On Demand expression is always evaluated in the context of the active Filter and Paging

Expression and Evaluation mode relationship

The selection made for Expression and Evaluation modes work together to provide different outcomes

This table describes the relationship between the various options

Expression Mode
Evaluation Mode Empty Cells New Nodes All Nodes
None The value will be interpreted as a literal, printed to populate the property's cell if that cell does not otherwise carry a value. The default value is not persisted on save The value will be interpreted as a literal, populating the property's cell if no other value was presented at creation time. The value is persisted on save The expression will be printed to populate the property's cells, regardless of whether the cell carries a persisted value or not
Pre-filter The expression will be run before the data is filtered for a visualization and this will populate the property's cells The expression will be run on node creation, independently of filtering, and the return value will populate the property's cell. The output will be saved after the expression is run in the dataset The expression will be run before the data is filtered for a visualization and this will populate the property's cells
Post-filter The expression will be run after the data is filtered for a visualization and this will populate the property's cells NA (evaluation of New Nodes value is always pre-filter) The expression will be run after the data is filtered for a visualization and this will populate the property's cells
On Demand The expression will be run after the data is filtered for a visualization and this will populate the property's cells. The values will be saved to the dataset after the expression is run. Will only populate blank values in the property NA (evaluation of New Nodes value is always pre-filter) The expression will be run after the data is filtered for a visualization and this will populate the property's cells. The values will be saved to the dataset after the expression is run Will be applied to all property values regardless of whether they are already populated or not

Lookup Properties

New or existing properties may be linked to lookup datasets that have either:

  • A. Loaded into your tenant with the dataset type set to Lookup
  • B. Tagged lookup on the Dataset Metadata screen

image

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

If a new Property is being added to link to a lookup, follow the steps in Add Property to complete the mandatory fields on the General tab first

To set a Property to reference a lookup table:

image

  1. Select the Values tab on the Edit Property window
  2. Then select Provide users with a list of set values checkbox
  3. Select Provide values from a Lookup Dataset (Manual) checkbox
  4. Select required dataset from list
  5. Select Save to complete the Lookup

The properties in the lookup dataset will then be available in workspace for use in gizmo expressions and will appear in Property selection panels in the format Property:lookup Property

To view a video showing how to upload a lookup table click the thumbnail to open the video in a new browser tab

Lookup

Auto Lookup Properties

If the Lookup dataset has been saved with the same name as the property being looked up from then it is also possible to use the Lookup Dataset (Auto) option by

image

  1. Select the Values tab on the Edit Property window
  2. Then select Provide users with a list of set values checkbox
  3. Select Provide values from a Lookup Dataset (Auto) checkbox
  4. Select Save to complete the Lookup

Using this option will not populate the properties from lookup dataset into workspace but they may still be referenced via Gizmo Expressions using the syntax

node.lookup("lookupproperty").lookedup-property

e.g.

node.lookup("location").currency

image

Master and Sub Tenant Lookup

Users with a master sub-tenant setup can create lookups in a master tenant, which will then be available to be applied to any dataset in a sub-tenant

For a dataset to be available as a lookup in a sub-tenant, one of the following options must be applied in the master tenant

  • A. Created in Master tenant with the dataset type set to Lookup
  • B. Tagged lookup on the Dataset Metadata screen

image

The lookup will become available to users in the sub-tenant when it is tagged as view:guest in the master tenant

image

Note: If an admin has access to both the master and sub-tenant, they will have access to the lookup regardless of any tags

Within the lookup dropdown, users will be able to identify a lookup from a master tenant as an option with an information icon next to it

image

Expression Lookups

An expression lookup allows you to define what options are available when updating a Text Property value by providing users with a set of values

This may be useful to limit inputs to a Property value to ensure data cleanliness

An example of this may be to limit the locations available to select, to only London, New York & Paris

This can be done for existing or new properties

To apply an expression lookup to a new Property first follow the steps in Add Property

image

For new, or existing properties:

  1. Select the Values tab on the Edit Property window
  2. Then select Provide users with a list of set values checkbox
  3. Select State what users can enter checkbox
  4. The list of permitted values should be entered into the Drop-down list box and pressing Enter for each option to include a line break
  5. If required this list of values may be pasted from the clipboard using the Paste option
  6. The Stop users from entering any other values checkbox is used if only the options in the Drop-down list are permitted for entry If the checkbox is not selected then the lookup values will be available in the dropdown to select from, but other values may be entered too
  7. Select Save to complete the Lookup

Note: The order in which values are entered into the expression will also define their order as Property buckets in any visualizations

Any Property with a lookup expression will show the lookup icon on the data panel when selected

image

results matching ""

    No results matching ""

    results matching ""

      No results matching ""