Overview

top

Numeric and Text based data displayed in a report can be translated from values held in the database to more meaningful values by adding a reference code to a dimension. This mapping is called Reference Codes. The Ref Code Manager page allows administrators to edit existing Reference Codes created through the Model. See Reference Code Use for more information on creating Reference Codes.

Navigate to Administration > Admin Console > Reference Codes to access a list of available Ref Codes.

From here, simply click on the Code you wish to update to open it in the manager.

Name & Usage

top

The first thing you will see in the manager is the name and current View usage of the code. Here you are able to update the name of the set of codes.

Configuration

top

Here you are able to toggle various features available to the Reference Code.

  1. Custom Sort: this allows you to apply a sort order other than alphabetical. For example, you could sort months chronologically by setting January = 1, February = 2, etc.
  2. Custom Colours: this allows you to assign colours to the various values of the field. These colours can be used in charts and filters to ensure that values are easily identified and consistent across reports.
  3. Custom Images: this allows you to assign images to the various values of the field. These images can be used with In List filters in order to aid the user in selecting values. The image will be displayed next to the value in the list.

Code Definitions

top

Here is where you define the values for the Code and any other options enabled in Configuration (above).

  1. Code: this is the value found in the database that will be replaced with the description value.
  2. Description: this is the value that will be displayed in the report/filter rather than the code.
  3. Sort #: this is the order the value will appear when sorted.
  4. Colour: this is the colour applied to the value, displayed in charts and filters (when selected).
  5. Image: this is the image displayed next to the value in filters (when enabled).

Here you can also add additional codes that you may not have included when originally defining the Org Ref Code. Simply enter the values required and click the Add button.

Once complete, click the Save button at the bottom of the page.

 

top