Dataset Metadata
Selecting:
- The Dataset Name from the Dataset List
- The
Edit
option from the ellipsis menu on the Dataset card from workspace homescreen
Will open the Dataset Metadata screen which contains:
- Name: This can be amended
- Type: This can be amended
- Owner: Non-amendable field
- Node Relationship: See Node Relationship for details
- Label: See Label Property for more details
- Node Parent ID: See Parent ID for more details
- Auto ID: See Auto ID for more details
- Tags: Free text box to add any Dataset tags See Tags for further details
- Read Only*: Listed roles have read only access, click into window to select from existing roles to add or type new role name
- Update*: Listed roles have view and update access to dataset, click into window to select from existing roles to add or type new role name
- Modify*: Listed roles have edit access to dataset, click into window to select from existing roles to add or type new role name
- Manage*: Listed roles have edit access and the ability to create views and drafts from dataset, click into window to select from existing roles to add or type new role name
- Dataset ID: See Dataset ID for more details
- Default View ID: See Default View ID for more details
- Date Created / Created By: Non-amendable for information only
- Node & Property Information: Summary of Dataset contents
- Manage Properties
- More detail Menu, Open to select from:
* Dataset Permissions: See Dataset Permissions for more detail
Some options can also be accessed directly from the Dataset List by:
- Selecting the checkbox for a Dataset
- Selecting the
Edit
icon will open the Dataset Metadata screen - Selecting the More detail Menu to select from:
Node Relationship
The node relationship selector enables the choice of either Flat
or Hierarchical
configuration for the dataset
Note: The dataset must contain a Parent ID property to be able to set the node relationship to
Hierarchical
To switch a dataset from Hierarchical
to Flat
select the Flat
radio button
To switch a dataset from Flat
to Hierarchical
:
- Select
Hierarchical
radio button - Select the Parent ID to set the hierarchy structure
Label Property
The label property is used within Workspace to display against nodes and is shown as the default node label in all slides
Users can change the Label for their Dataset via the edit metadata page for a Dataset by:
- Clicking the Label field on the Dataset Metadata Screen
- Selecting the new property to use as the label from the list
Changing the Label will only update the Dataset and not apply to any views previously created
So if the Label has been changed for a Dataset it will be shown when any Pack is next opened directly from that Dataset
However, the original label property will continue to be displayed on any packs created from a previously created view
Parent ID
It is possible to change the ID used in a hierarchical Dataset to parent by
and therefore display different hierarchy structures
This may be useful in Datasets with matrix reporting structures
It is also possible to change the parent by
property while in a hierarchical dataset in workspace. See Parent By in Workspace User Guide for more details
To change the property used to parent by
simply:
- Click the Parent ID field on the Dataset Metadata Screen
- Select the property from the pop-up window
Changing the Parent ID
property will change the hierarchy in any pack created from the Dataset when the pack is next opened in Workspace
Note: For any existing views this change will not propagate down and the initial
parent by
for the view will remain
Auto ID
The auto ID property is the property initially set as the ID property for each node when the dataset was first created
It is possible to change the property set as the ID property by selecting a new property from the property selection panel
To select a new Auto ID
property:
- Select the
Auto ID
field to open the property selection panel - Select the property to set as the ID property of the dataset
Note: For any existing views, this change will not propagate down and the initial
ID
for the view will remain
Dataset ID
The Dataset ID is a non-amendable unique ID number automatically assigned by Orgvue when the dataset is created which may be used to identify the correct dataset if there are multiple datasets with identical names
Default View ID
The Default View ID is a non-amendable unique ID number automatically assigned by Orgvue when the dataset is created which is used within Orgvue API transactions to identify the required dataset. This ensures that API transactions are able to allow for dataset name changes
Dataset Filter
A Dataset Filter is similar to a View created in Workspace as it allows users access to specific records and properties from a Dataset based on a property tagged with aggregate
in settings
The difference however is that it may remain fully editable (subject to permissions applied by the Dataset owner) and any data edited will be reflected in the base Dataset as soon as the filtered Dataset is saved
Any changes in the base will also show in the filtered version
Prerequisites
To create a Dataset Filter:
- A. Firstly ensure that any properties you wish to filter on, are tagged
aggregate
in the Property Manager for the Dataset - B. If you wish to preserve ghost nodes in the prefiltered Dataset ensure that the Parent ID has the tag
index
- C. To provide access to the filtered Dataset, the source Dataset must have the permission tag in the format
filter-[Level]:{role}
in addition to any permission tags applied to the filtered Dataset. See Tags for more detail of tags available to use with a Dataset Filter
Create Dataset Filter
To create a Dataset filter once any required properties are tagged aggregate
you can either:
- Select the Dataset on the Dataset List, then open the menu and select
Create Dataset Filter
- From the Dataset Metadata screen of the Dataset, open the menu and select
Create Dataset Filter
This will open a window to create the prefilter with the following detail:
Important: once created a dataset filter cannot be edited, so any changes will require the dataset filter to be deleted and a new one created
- Enter name of prefilter to be shown on Workspace
- Select a property tagged “aggregate” to filter on. Only text and Boolean properties may be used
- Select the buckets from the “Filter on property” to include in the filter
- Add further properties to filter on
- Number of nodes included in filter shown
- Add permission tags to enable access *
- Select the property that will be used to create the hierarchy
- Unselect the properties that you do not wish to include in the prefilter
- The number of properties selected will be shown
- Select the create button to complete the creation process
* e.g. To make the filtered dataset visible to users it must be tagged view:user
Note: Any tags to restrict access to editing properties within the filtered dataset should be added to the source dataset
See Filtered Dataset Permissions for more detail
The filter buckets are created using an AND
statement. This means that if a Node is to be included in your data slice where more than two properties are used as buckets, then it must satisfy both conditions e.g. Location = UK AND Department = Project Delivery
The filter must contain more than 0 nodes to allow creation
Delete Dataset Filter
Once created, the Filtered Dataset will be available to use in Workspace but will not be shown in Dataset List and cannot be amended once created
To delete a Filtered Dataset in Workspace:
- Click the menu button
- Select
Delete Prefilter
Copy Dataset Property Metadata
It is possible to copy all the property metadata from one Dataset to another Dataset
This allows you to make a copy of a Dataset's structure so that you can recreate it in another Workspace without copying the actual node data
To copy Dataset property metadata either:
- Select the Dataset on the Dataset List, then open the menu and select
Copy Data Properties
- From the Dataset Metadata screen of the Dataset, open the menu and select
Copy Data Properties
This will open
1 Select Metadata
On the Select metadata screen:
- Select which properties from the source Dataset are to be copied
- Select the target Dataset type and Dataset name from the dropdown list. This list will only display active Datasets and the Dataset type will initially default to match that of the source Dataset
- Select the option to include any property tags when copying the Dataset structure
- Select Next to progress to the next step
Note: It is not possible to:
- Copy property metadata between Datasets in a master and sub tenant
- Copy from_id, to_id and link_id from a links Dataset
2 Summary
- A. The Summary page will display the changes that will be applied to the target Dataset split by:
- Properties added
- Properties changed
- Properties unaffected
- Properties unaffected due to permissions
- B. The properties shown in the list will be color coded to show what level of change is being applied
- C. Once the change summary has been reviewed click, Copy to complete the process or Cancel to exit the process
Note: The process of copying property metadata will not delete any properties from the target Dataset, so this line of the summary will always be zero
3 Confirmation
The final page will display a confirmation message that the properties have been successfully copied