Metadata Schemas

A Metadata Schema is used to define the metadata fields that need to be filled out on the Metadata screen of an asset. Each schema defines the fields and their type, whether or not it is required, the default value of the field, whether or not it can be edited and which fields appear in the HTML source code of the page. You can create as many Metadata Schemas as you want in the system.

Once you have added a Metadata Schema, you can configure its settings on its associated asset screens. These screens are often the same or similar to those for a Standard Page and are described in the Asset Screens manual. In this chapter, we will describe the Details and Usage screens, which are different for an Image.

Details Screen

The Details screen allows you to set up your Metadata Schema by adding sections and fields.

For more information about the Status section, refer to the Details Screen chapter in the Asset Screens manual.

Details

The Details section of the Details screen is shown in the figure below.

The Details section of the Details screen

By default, the name that was entered into the Schema Name field when the Metadata Schema was created will appear in this section. You can change the name of the Metadata Schema by clicking into the Schema Name field and entering the new name for the Metadata Schema.

Sections Defined For This Metadata Schema

This section shows the sections and fields that have been added to the Metadata Schema. It also allows you to delete fields and sections. If you have not added any sections, no information will appear, as shown in the figure below.

The Sections For This Metadata Schema section with no defined sections

When you add a section, it will appear in this section of the screen, as shown in the figure below.

The Sections For This Metadata Schema section with a section

Each blue heading represents a section that has been added to the Metadata Schema. For example, in the figure below, two blue headings appear - User Defined and System Defined. This means that two sections have been added to this Metadata Schema.

The Sections For This Metadata Schema section with two sections

For each section listed, the following fields are available:

• Delete?: to delete a section and all of its fields, click this box and click Commit. The section will be removed from the Metadata Schema.
• Section Description: by default, this field will not appear on the screen until you have added a metadata field to the section. Once you have added a metadata field, this field will allow you to enter a description for the metadata section that can then be displayed on the Frontend.
• Current Restrictions: by default, this field will not appear on the screen until you have added a metadata field to the section. Once you have added a field, this section will list which asset types this metadata section will be applied to. By default, no asset types will be listed. Once you have selected an asset type from the New Restriction list, it will appear in this section, as shown in the figure below.    

  
  A Current Restriction on a metadata section    

    If no asset types are listed, the metadata section will be displayed for all assets that the Metadata Schema is applied to.
• New Restriction: by default, this field will not appear on the screen until you have added a metadata field to the section. Once you have added a metadata field, this field allows you to restrict which asset types the metadata section is applied to. For example, if you are going to apply the Metadata Schema to all assets in your Site but only want this metadata section and its fields to be applied to Standard Pages, select Standard Page from the list. To select multiple asset types, click the More…button. An additional field will appear on the screen. The asset types that have been selected will appear in the Current Restrictions list.
• Fields: this field lists the metadata fields that have been added to the section. If you have not added any fields to the section, no information will appear, as shown in the figure below. When you add a field, it will appear in this section of the screen, as shown in the figure below.    

  
  A metadata field in a metadata section    

    To edit a field, click on the Edit Metadata Field link. You will be taken to the Details screen for that field. To delete a field from a section, check the Delete box and click Commit.    

  Tip: To rearrange the order of the fields you can move the field assets that appear under the Metadata Schema in the Asset Map

• New Field Name: to add a new field to the section, enter the name of the field into the box provided.    

  Tip: Create your metadata field names using only alphanumeric characters, full stops, hyphens or underscores, The use of spaces in field names is not recommended, because you will not be able to reference the field in other assets.    

• New Field Type: when you are adding a new field, select the type of field from the list provided. These options include:    
  • Thesaurus: the user must select a value for the metadata field from a pre-defined list of Thesaurus Terms.
  • Text: the user can enter only text into the field.
  • Select: the user must select a value from a pre-defined list of values.
  • Multiple Text: the user can enter a list of values into the field.
  • Date: the user can enter a date and/or time into the field.
  • Hierarchy: a 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.
  • WYSIWYG: the user can enter rich text via the WYSIWYG Editor into this field.
  • Related Asset: the user can select a related asset. The attributes of this asset can then be dynamically retrieved through the use of keyword replacements, used within the content of the page.

For more information about each of these fields refer to the corresponding chapters in this manual.

Create New Section

This section allows you to add new sections to the Metadata Schema. Enter the name of the new section into the Section Name field and clickCommit. A new section will appear in the Sections Defined For This Metadata Schema section.

Regenerate Metadata Files

If you have made changes to a Metadata Schema and it has already been applied to assets in the system, your need to regenerate the metadata files before your changes will affect these assets. To do this, check the Regenerate metadata files box and click Commit.

Options

This section allows you to decide whether or not to show the Metadata Schema in the HTML source code of the page. By default, this value is Yes meaning that all sections and fields will appear in the HTML source code.

Please note that metadata does not automatically appear within the HTML source code of a page, unless your Design includes the Metadata design area. For more information on this design area, refer to the Designs manual.

Usage Screen

The Usage screen shows the assets in the system that are using the Metadata Schema. This means that the Metadata Schema is currently either applied or denied on the asset. The Schema Usage section of the Usage screen is shown in the figure below.

The Usage screen of a Metadata Schema

By default, if the Metadata Schema has not been used on any assets, no information will appear on the screen, as shown in the figure above. Once the Metadata Schema has been used on an asset, the information shown in the figure below will appear.

The Usage screen listing the assets using the Metadata Schema

The top level assets where the Metadata Schema has been applied are shown. Child assets will be displayed in the table only when their schema options differ from their parents. You can click the name of an asset to go to its Settings screen.

Sections

A section allows you to group metadata fields. You need to add a section before you can add a field to the Metadata Schema. Within the HTML source code of the page, a section will appear as a comment.

Adding a Section

To add a section to a Metadata Schema, go to the Details screen of the schema. Enter the name of the new section into the Section Name field and click Commit. A new section will appear in the Sections Defined For This Metadata Schema section, as shown in the figure below.

A new metadata section

A section asset

A Metadata Section asset will also appear under the Metadata Schema in the Asset Map, as shown in the figure to the right.

Editing a Section

To edit a section, right click on the Section asset in the Asset Map and select Details. The Details screen of the Section will appear.

Details

This section allows you to change the name of the section and add a description. The Details section of the Details screen is shown in the figure below.

The Details section of the Details screen

The following fields are available:

• Section Name: enter a new name in this field to change the name of the section. By default, the name that was entered when this section was created will appear in this field.
• Section Description: enter a description of the section into this field. This will be displayed on the Metadata screen of an asset. It can be used to display information to your users about the metadata section. For example, if your section is called User Defined you may wish to enter a description This section is for metadata defined by site users.

Options

This section allows you to decide whether or not to show the section and section description in the HTML source code of the page. The Options section of the Details screen is shown in the figure below.

The Details section of the Details screen

The following fields are available:

• Show On Frontend: select whether or not to show the section on the Frontend. By default, this value is Yes meaning that the section and all of its fields will appear in the HTML source code.
• Show Description On Frontend: select whether or not to show the section description on the Frontend. By default, this value is No meaning that the information entered into the Section Description field will not appear in the HTML source code.

Deleting a Section

To do delete a section and its fields from a Metadata Schema, go to the Details screen of the schema. In the Sections Defined For This Metadata Schema section, select Delete this section and all its fields for the section you want to delete and click Commit.

Fields

For a Metadata Schema, a field can only be added to a section. There are five different types of fields you can use within a Metadata Schema. These types include Thesaurus, Text, Select, Multiple Text, Date, Hierarchy and WYSIWYG.

Adding a Field

To add a field to a Metadata Schema, go to the Details screen of the schema. In the Sections Defined For This Metadata Schema, under the section you want to add the field to, enter the name of the field into the New Field Name, select its type from the New Field Type list and click Commit. The field will be added to the Fields list for that section, as shown in the figure below.

A metadata field in a metadata section

A Field asset will also appear under the section in the Asset Map, as shown in the figure to the right.

Editing a Field

A Metadata Field asset

There are two ways to edit a field within a Metadata Schema. On the Details screen of the schema, click on the Edit Metadata Field link for the field. This will take you to the Details screen for that field. Alternatively, you can right click on the Field asset in the Asset Map, as shown in the figure to the right, and select Details.

The Details screen for each field type is described in the sections below.

Deleting a Field

To do delete a field from a Metadata Schema, go to the Details screen of the schema. In the Sections Defined For This Metadata Schema section, check the Delete box for the field you want to delete and click Commit.

PreviousNext