Display Link Metadata on the Data Catalogue Page - SuperWEB2

If you have configured SuperWEB2 to use the metadata server for multilingual datasets, then you can choose to display link metadata on the data catalogue page.

When this option is activated, links will be displayed automatically at the bottom of the data catalogue page whenever there is a link available in the db_domain table in the metadata database.

This setting only applies for datasets where the multilingual property has been set to true in SuperADMIN.

Step 1 - Activate the Metadata Description Setting

To activate this option, you need to change a setting in the configuration.properties file (if you have not already done so):

1. Open <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties in a text editor.

2. Locate the following setting:

   CODE

   catalogue.infoPanel.displayDatabaseMetadataDescription=

3. Change the setting to true:

   CODE

   catalogue.infoPanel.displayDatabaseMetadataDescription=true

4. Save your changes and restart Tomcat or the SuperWEB2 service.

Step 2 - Ensure that your Metadata Database has been Configured to Include Links

To display links, your metadata database must have been configured to include link type metadata, and contain link columns in the db_domain table. If you did not include link metadata in the metacolumns.txt file at the time you originally generated your external metadata database, then you can add it as follows:

1. For each language where you want to have link metadata, insert a row in the meta_<repository_id> table with the ss_type set to link. For example:
   

   

2. Alter the design of the db_domain table so that it includes the link columns. These must have the same column name as the values you set for the ss_column in the meta_<repository_id> table. For example:
   

   

Step 3 - Populate the Metadata Database with Links

Once your metadata database has been set up with the appropriate link columns, you need to populate the links in the db_domain table. SuperWEB2 will automatically display the link at the bottom of the data catalogue if it exists for the selected dataset and language.

For example, if you add the following value to the metadata database:

Then a link similar to the following will display in SuperWEB2 when Retail Banking is selected and the dataset language is set to English:

Step 4 (Optional) - Configure the Link Text

By default, the link text will read Other Metadata. You can change this if you want to use different text by editing the common_labels.properties files, located in <tomcat_home>\webapps\webapi\WEB-INF\classes

There will be multiple copies of this file for different languages and locales, with names like common_labels_en.properties and common_labels_de.properties. Each one contains the text used for different languages. Depending on which languages are in use on your deployment, you will need to make these changes in all versions of this file. The properties file that is used will depend on the language settings in the end user's web browser, the set of supported locales defined in the faces-config.xml configuration file, and the user interface language selected by the user from the drop-down list. See Multilingual and Localisation Support - SuperWEB2 for more information about localisation and how SuperWEB2 uses the properties files.

1. Open the common_labels.properties file in a text editor.

2. Locate the following line:

   CODE

   catalogue.infoPanel.metadataLinkLabel=Other Metadata

3. Change the text to your preferred string. For example:

   CODE

   catalogue.infoPanel.metadataLinkLabel=Learn More

4. Save your changes.

Once you have completed the change for all locales, restart the SuperWEB2 Tomcat service to see the changes: