By default, metadata icons automatically appear in tables alongside the fields that you have added to the table.
If you wish, you can also configure SuperWEB2 to display metadata icons in the field list, for selected fields, groups, measures and field items/values:
You have two options for activating these metadata icons:
- If you are using the metadata server SuperWEB2 has an option to automatically scan the metadata database for descriptions. It will automatically display the icons in the field list whenever a description appears in the metadata database for a particular item in the current dataset language.
- Alternatively, you can manually configure which fields, groups, measures and field items you want to show the icons for. This option works for both static HTML pages and when using a database metadata repository.
Option 1 - Configure SuperWEB2 to Scan for Metadata Descriptions
To configure SuperWEB2 to scan for descriptions, and automatically display the links in the field list accordingly, you need to edit a setting in the configuration.properties file.
- Open <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties in a text editor.
Locate the following setting:
Change the setting to
- Restart Tomcat or the SuperWEB2 service.
- Log in to SuperWEB2 in a web browser and check that the metadata icons appear whenever there is a description in the metadata database (note that you may need to clear the metadata cache to see any changes you make in the external database).
Option 2 - Configure SuperWEB2 to Display Metadata for Specific Items
Step 1 - Obtain the IDs from SuperADMIN
The metadata icons can be turned on or off individually for fields, measures, groups and field items/values.
The first step is to obtain the IDs for every field, group, measure or field item where you want to show the metadata icon. You can obtain these in SuperADMIN using the following commands:
<dataset_id>is the ID of the relevant SXV4.
<measure>are the name of the field, measure or group you want the ID for.
The information you need is the ID value. In this example, the IDs are
In some cases there might be multiple items with the same name. For example:
In this case, "Accounts" represents a summation field (the record count for the corresponding fact table) a group of cross tabulation fields, and a group of non-summation/non-cross tabulation fields. Choose the appropriate ID depending on which one you want to show the metadata icon for. (The group represented by the third ID,
SXV4__Retail_Banking__Accounts_DGRP, is not visible in SuperWEB2; the fields in this group are available for creating user defined fields in SuperCROSS).
Step 2 - Configure Metadata Icons
To configure SuperWEB2 to show the metadata icon for a particular field, measure, group or field item use the following commands:
Check Which Fields, Groups and Measures are Configured to Show Icons
Use the following commands to check which items currently have metadata icons activated:
SuperWEB2 will either display a list of IDs (if some items already have metadata icons activated), or display "not found".
These results indicate that for the bank dataset:
- No fields or field items currently have metadata icons activated.
- Metadata icons are currently enabled for the Customers group and the Account Profit and Customer Profit measures.
Activate Metadata Icons for a Field, Group or Measure
Use the following command to activate the icons for a specific field, group or measure:
For example, the following commands activate metadata icons for the Gender and Marital Status fields, the Accounts group and the Average Account Balance measure:
Activate Metadata Icons for a Field Item
Use the following commands to activate the icons for a specific field item:
For example, the following commands activate metadata icons for the Male and Female items of the Gender field:
Deactivate Metadata Icons for a Field, Field Item, Group or Measure
To turn off the metadata icon for a specific field, field item, group or measure, use the following command:
To use this command, you need to know the index value of the item you are removing (this depends on the order it was added). To find this out, query the fields, groups or measures.
In this example, there are three measures that have metadata icons activated: Account Profit, Customer Profit, and Average Account Balance.
Suppose we want to deactivate the metadata icon for Customer Profit. This is the second one in the list, so because the index numbering starts at 0 we would need to use an index value of 1:
Deactivate All Metadata Icons for Fields, Groups or Measures
As an alternative, if you want to remove the metadata icons for all the fields, groups or measures in a specific dataset, use the following command: