Creating extended properties

Note:
You can concurrently create multiple extended properties, including those with children.
When you create extended properties, they can only have child properties if the data type is set to Object.

To create an extended property, do the following:

1. Ensure that the Properties tab of the Settings page is selected.
2. Select Extended, positioned under the title of the tab.
   The currently defined Extended properties display.

Example of the Properties tab of the Settings page, with Extended selected

3. Click Add extended properties.
   The Add extended properties page displays.

The Add extended properties page

4. Under Label, enter a name for the extended property.
   This is the name that is visible in the UI.
5. Under Key, enter the the key that is used to identify the property in the database.
   A key cannot include spaces or special characters.
6. Under Type, do one of the following:
   1. To create an extended property without children, select any data type except Object.
      See Understanding properties for more about data types.
      or:
   2. To create an extended property with children, select Object as the data type.
      The Nested properties panel displays.
   3. Enter the Label, Key and Type for the child property.
      Note:
      The Object type is not available.
   4. Click Add an item to add further child properties, as required.

The Add extended properties page with the Nested properties panel

7. Set the Can be null switch as required.
   Defines whether the data type can have a value of zero.
   The switch is set to On by default.
8. Click Add properties , positioned near the top of the page, to create further individual extended properties, as required, and repeat Steps 4 – 7.
   These can be properties with or without children.
9. Click Save to create the extended property or properties, or Cancel to abort the process.
   You are returned to the Properties > Extended tab and each individual extended property is added to the list, with the data type displayed next to the name.

You can enable or disable an extended property in the same way as base properties. See Enabling and disabling base properties for more details.

Note:
You cannot delete or modify an extended property, although if it has children, you can add new ones, or turn the existing ones on or off.

Viewing and managing child properties

To view a property’s children, click the downwards pointing arrow, positioned to the right of the relevant panel.

Example of a property with children

If a child property is disabled, its switch turns light gray. You can disable all of the relevant child properties by using the switch belonging to the parent.

Note:
If disabling a child property results in an invalid JSON string, a warning displays and the switch is reset.

Adding a child to an extended property

To add a child to an extended property, do the following:

1. Locate the appropriate extended property and click the ‘+‘  icon, positioned to the right of the panel.
   The Add child properties page displays.

The Add child properties page

2. Enter the Label, Key and Type for the child property.
   Note:
   The Object type is not available.
3. Click Add properties to add further child properties, as required.
4. Click Save to create the child property or properties.
   You are returned to the Properties > Extended tab and the child/children are added to the appropriate extended property.

Downloading a JSON file

To download a JSON file that represents the schema for all extended properties, do the following:

1. On the the Properties Extended tab, click Download JSON.
   An Open File dialog displays.
2. Select whether to open the JSON file with an appropriate program, or to save it locally.
3. Click OK to proceed.

Previous page: Enabling and disabling base properties | Next page: Understanding events