dumpcodes.properties

This file allows you to blacklist certain field values from mapping. Users will not be able to access Map View if the table contains one of the blacklisted field values.

The blacklisted field values must come from a valueset that is already mappable. This feature allows you to select specific field values from within a field that is otherwise mappable, and prevent access to maps if those fields are in the table.

To configure a list of blacklisted field values, you need to:

1. Find the codes for the values you want to blacklist. You can do this by adding the values to a table in SuperWEB2 and clicking the code button in the table header.
2. Add the codes to the comma separated list in the dumpcodes.properties configuration file.
3. Restart Tomcat or the SuperWEB2 service.

Worked Example

The following example is based on the sample Retail Banking database and the mappable Area field. In this example we will blacklist a selection of the field values so that users cannot create maps if their table includes those values.

1. Go to SuperWEB2 and create a table containing the values you want to blacklist. For example, there are a number of regions in the Area field that we might want to exclude from mapping:
   

   

2. Click the code button to view the value codes:
   

   

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

   

   There may be multiple copies of this file for different languages and locales with names like dumpcodes_en.properties, and dumpcodes_en_AU.properties.

   As this file does not need to be localised, you may wish to delete the _en and _en_AU versions so that there is only a single version (dumpcodes.properties) that needs to be configured.

   If you choose not to delete them, you need to make sure you complete these steps in all copies of the file. The properties file that is used will be selected based on the language settings in the user's browser and the set of supported locales defined in the faces-config.xml configuration file (see Multilingual and Localisation Support - SuperWEB2 for more information about localisation and how SuperWEB2 uses the properties files).

4. Edit the comma separated code list to include the values you want to blacklist:

   CODE

   codes=785,-1,585,485,385,285,185

5. Save your changes to the file and restart Tomcat or the SuperWEB2 service.

6. Verify that Map View is no longer available if you create a table containing any of the blacklisted field values, and that Map View is available once the blacklisted field values are removed:

   In this example Map View is unavailable because the table contains "Off-Shore Areas & Migratory":

   The Map View tab becomes available once this field value is removed from the table:

The text for the error message ("You have included non-geographic items...") is defined in <tomcat_home>\webapps\webapi\WEB-INF\classes\common_labels.properties (and the equivalent versions of this file for the different languages and locales). If you choose to modify the error message, make sure you do so in all the localised versions of this file.