You can add metadata about datasets, tables, and fields to SuperWEB2. Once the metadata is set up, end users can click the links in the SuperWEB2 interface to read the additional information about the data they are working with.
Metadata links are available in SuperWEB2's Table View mode, for any fields that have been added to the table. The links are denoted by theicon:
It is also possible to configure SuperWEB2 to show metadata icons in the field list:
This page describes how to set up metadata for SuperWEB2 using a database repository.
Setup a Metadata Database
To set up a metadata database, complete the following steps:
Follow the instructions to set up multilingual databases using Metadata Server, if you have not already done so.
- Open <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties in a text editor.
Locate the following property:
Change the value to
- Save your changes to configuration.properties.
- Restart SuperWEB2 or the Tomcat service.
Once you have made this change, you can verify that the metadata database is set up correctly:
- Login to SuperWEB2 and create a table.
View the metadata for one of the fields in the table. For example:
Go to the metadata database in your relational database system and edit the metadata description for this field. For example:
- Clear the Metadata cache.
View the metadata in SuperWEB2 again and check that you can see your updated description. For example:
Now that you have verified that SuperWEB2 is accessing the metadata from your database, you can proceed to add appropriate descriptions for all the fields.
By default, the metadata icons are displayed in the table when fields are added. If you wish, you can also configure SuperWEB2 to display the metadata icons in the field list.
Additionally, if you wish you can configure SuperWEB2 to display all the descriptions for the current table as annotations, below the table. See Display Metadata as Annotations Below the Table - SuperWEB2 for more details.