Hierarchy Field

A Metadata Hierarchy Field is similar to a Select Field where the user can select a value from a pre-defined list of values. This list, however, can show a hierarchy of information.

Details Screen

The Details screen allows you to configure the settings for the Metadata Hierarchy Field.  

Details

This section allows you to change various details to do with the hierarchy field. The Details section of the Details screen is shown in the figure below.

The Details Section of the Details screen for a Hierarchy Field

The following fields are available:

• Field Name: by default, the name that was entered when this field was created will appear in this field. You can change the name of the field by clicking into this field and entering the new name.  

  Tip: You should choose a name for your field that is unique across all Metadata Schemas in your system.  

  • Friendly Name: enter a friendly name for the field. This will be displayed as the field name on the Metadata screen of an asset. If the name of the field is complicated or does not reflect what should be entered, you may want to enter a Friendly Name. For example, if you have named your field DC.Keywords, you may want the label on the Metadata screen to show Keywords instead.
  • Description: enter a description for the field. This will be displayed on the Metadata screen of an asset. It can be used to display instructions to your users about how to enter a sensible value into the metadata field. For example, if your field is called Keyword you may wish to enter a description Please select a keyword from the list provided.
  • Scheme: enter the industry standard scheme for this field, for example AGLS. This will be placed in the HTML source code of a page.
  • Language: enter the language for this field, for example English. This will be placed in the HTML source code of a page.

Settings

This section allows you to set up the list for this metadata field. If you have selected Flat View in the Display Type field, the fields shown in the figure below will appear.

The Settings section for the Flat View Display Type

The following fields are available:

• Options List: this section shows the options that have been added to the list. It allows you to change the Key and Value or delete an option from the list. If you have not added any options, no information will appear in this section, as shown in the figure above. When you add an option, it will appear in this section, as shown in the figure below.  

  
  The Options List  

  By default, the Key and Value that was entered when the option was created is displayed. You can change the Key or Value by clicking into the relevant field and entering the new value. To delete an option from the list, select the Delete box and click Commit.
• New Option: this field allows you to add a new option to the list.
• Key: enter the key for the option. By default, this is displayed in the HTML source code of a page.  

  Tip: When using the Drill-Down View display type, the Option Keys should maintain a constant character length (per level) to be displayed correctly in the Hierarchy Field. For example, the Keys 'banana' and 'orange' will appear correctly, while 'banana' and 'apple' would not.  

• Value: enter the value for the option. By default, is displayed in the list on the Metadata screen.
• Default Value: this section allows you to select a default value for the list. If you have not added any options, this field will not appear on the screen. When you add an option, a list will appear, as shown in the figure below.  

  
  The Default Value list  

  Select a default value from the list of options.

• Preview the Hierarchy: this field shows a preview of what the list will look like on the Metadata screen. For the Flat View, this preview will be a list of the values.

If you have selected Drill-Down View in the Display Type field, the fields shown in the figure below will appear.

The Settings section for the Drill-Down View Display Type

For more information on the Options List, New Option and Default Value fields, refer to the information above.

The following fields are available:

• Preview the Hierarchy: this section shows a preview of what the hierarchy will look like on the Metadata screen. Each level in the hierarchy is shown followed by the list of selected values. For example, in the figure shown above there are two levels in the hierarchy followed by the list of selected values, which is empty. When you click the first Add button, a will be added to the selected values. When you click the second Add button, a.a1 will be added to the selected values.

View Options

This section allows you to select which hierarchy view to use.The View Options section of the Details screen is shown in the figure below.

The View Options section

The following fields are available:

• Display Type: select which type of list to use for the hierarchy field. By default, Flat View is selected, meaning that a normal list, similar to a Select Field, is used. To use the hierarchy list, select Drill-Down View in this field.
• Contextable?: select whether or not this field is context-aware. If you select Yes, this field will be allowed to take a different value for each context within the system. The default value of this field can also be set individually for each context. For more information, refer to the Contexts manual.
• Allow Empty: select whether or not to allow the user to select an empty value from the list. By default, this field is set to Yes.

Flat View Options

This section will appear if you have selected Flat View in the Display Type field.The Flat View Options section of the Details screen is shown in the figure below.

The Flat View Options section

The following fields are available:

• Show Structure: select whether or not to show the structure of the hierarchy in the list. By default this is set to No.
• Allow Multiple: select whether or not to allow the user to select multiple values from the list. By default, this value is set to No meaning that the values will appear in a drop-down list. If this value is set to Yes, this values will appear in a multi-select list where the user can select multiple values by holding down the Ctrl or Shift key.
• Sort Hierarchy: select which value to sort the list of values by. By default, Not Sorted will be selected in this list. You can choose to sort the list by the key or value.  

  Tip: To show the hierarchy in the list , select Yes in the Show structure field and Sort by Key in the Sort Hierarchy field.  

Drill-Down View Options

This section will appear if you have selected Drill-Down View in the Display Type field.The Drill-Down View Options section of the Details screen is shown in the figure below.

The Drill-Down View Options section

It allows you to label each level in the hierarchy. Depending on the number of levels you have in the hierarchy, will depend on the number of fields shown in this section. For example, in the figure shown above, the list that has been set up for this field has two levels, hence two fields appear in this section. The labels entered into these fields will appear in the Preview the Hierarchy field and on the Metadata screen next to each level in the list.

PreviousNext