Admin - Metadata

Overview

Metadata is critical in this next evolution of the platform. Establishing good naming conventions and tagging processes will ensure that we can quickly find the tools, templates and documents we need quickly.

We have implemented Dynamic Parameters and Entity Parameter lists to help with the creation and management of system metadata.

Dynamic Parameters

Dynamic Parameters allow admin users to add and manage new parameters without the need to implement code changes. With this new feature you can define a Parameter for any feature in the Portal.

Entity Parameters

Entity Parameters are essentially the functions of the platform that are available to use the Dynamic Parameter. In the Entity Parameters List you can manage which Dynamic Parameters are associated with which platform entities.

Permissions

As a user with Dynamic Parameter permissions, you will be able to Add, Edit and Delete Dynamic Parameters from the Portal.

To access Dynamic Parameters, you need to have the following permissions.

• DynamicParameter.View
• DynamicParameter.Create
• DynamicParameter.Edit
• DynamicParameter.Delete

Create a Dynamic Parameter

To create a Dynamic Parameter, click on your profile icon and select Administration to bring up the Administration Menu. Click on the Dynamic Parameter page under the Metadata and click on + Add Parameter in the top right corner of the page.

Then provide the Parameter a new unique name, select the type of parameter you would like and click Confirm to create the Parameter.

Parameter Type

We support 3 types of Dynamic Parameter fields, namely:

• Text Input: this is a free text box that the users can add data to in a free text format
• Single select: this is a single select box where the user can add a single option from the list provided
• Multi-select: this is a multi-select box where the user can select multiple options from the list provided

Once the Name and Type have been saved to the Portal, it's time to add the values associated with this Parameter. Do this by clicking on the newly created Parameter in the table. You will be presented with a menu to add the values to your new Parameter.

Simply type the values you wish to add, hit Enter to save the new value.

Edit a Dynamic Parameter

To edit a Dynamic Parameter, click on the Dynamic Parameter page and then click on the Parameter you wish to edit. You will be presented with a side menu which contains the values associated with the Parameter.

Click on the Parameter name to edit it. Click the green tick to save the changes or click the red cross to discard the changes.

You can also edit all the Parameter Values in-line.

Once you have modified the Parameter Value you can accept the changes by hitting Enter, tabbing out the field or clicking on the green tick.

Unfortunately, we cannot modify the Parameter type. If you find that you have created a field with the wrong type, then you will need to create a new Dynamic Parameter and Delete the old one.

Delete a Dynamic Parameter

To delete a Parameter, click on the Dynamic Parameter page and then click the trash icon for the Parameter you wish to delete.

To delete a value from a Dynamic Parameter, click on the Dynamic Parameter page and then click the Dynamic Parameter you wish to edit, then click on the ellipse and click Delete for the value you wish to delete.

Parameters List

In the Entity Parameters List you can manage which Dynamic Parameters are associated with which platform entities. To manage Dynamic Parameter values of an entity, navigate to the Entity Parameters List page.

Here you will find the list of Entities and the Dynamic Parameters that have been associated with them.

Entities you can associate a Dynamic Parameter with:

• Document
• Contact
• Organisation
• Matter
• Project
• Resource URL
• Project Template
• Project Task
• Project Template Task
• Standard task

Add a Dynamic Parameter to an Entity

To add a Dynamic Parameter to an Entity, navigate to the Entity Parameter List page, select the Entity you wish to add a new Dynamic Parameter to and click on + Add Parameter in the top right of the page.

Then select the Dynamic Parameter from the dropdown list.

There are no limits to how many Dynamic Parameters you can add to an Entity.

Delete a Dynamic Parameter from an Entity

To delete a Dynamic Parameter associated with an Entity, navigate to the Dynamic Parameter List page and then click the Entity you wish to Edit, then click on the Delete button for the Parameter you wish to delete.

This removes the Dynamic Parameter from the Entity view and the user will no longer be able to use this Parameter when tagging a Document or Resource.