Free cookie consent management tool by TermsFeed

Modifying Reference Data Tables

This content applies solely to Award Management, which must be purchased separately from the Appian base platform. This content was written for Appian 24.2 and may not reflect the interfaces or functionality of other Appian versions.

Introduction

The solution is designed to be customized to your organization's particular needs. The various interfaces in the out-of-the-box solution contain values that are stored in database tables. This information is called reference data.

The types of reference data in AM are:

  • Dropdown lists and their values.
    • See Modifying Dropdown Lists for instructions on how to add and deactivate values in dropdown lists, and add new dropdown lists.
  • Document templates.

You can identify reference data tables by looking for tables that have _R_ in the name, such as AS_AM_R_DATA.

This page describes the structure of the reference data tables.

Reference data table

Dropdown values for AM are stored in the AS_AM_R_DATA table. Updating this table allows you to control what dropdown values and lists display to end users moving through the award process. See Modifying Dropdown Lists for more information on how this table is used. See the following table for a description of the fields in the AS_AM_R_DATA table.

Name MySQL Data Type Appian Data Type Description
REF_DATA_ID int(11) Number (integer) The primary key.
REF_LABEL varchar(255) Text The name that the end user will see in the dropdown list.
REF_TYPE varchar(255) Text What reference type the value is grouped by. For example, Award Status.
REF_ICON varchar(50) Text The icon associated with the value. For more information, visit the Appian icons page.
REF_COLOR varchar(50) Text Determines the color associated with the data. Valid values: STANDARD, POSITIVE, NEGATIVE, ACCENT, or a specific hex value. For example, #FFBF00.
SORT_ORDER int(11) Number (integer) Determines the order of values displayed in the dropdown.
IS_ACTIVE tinyint(1) Boolean Determines if the value will display, or not. Valid values: 1, 0. 1 will display the value, and 0 will not display the value.
CREATED_BY varchar(255) Text The user who added the reference data originally.
CREATED_DATETIME timestamp DateTime The date and time that the reference data was originally added.
MODIFIED_BY varchar(255) Text The user who changed the reference data most recently.
MODIFIED_DATETIME timestamp DateTime The date and time that the reference data was most recently changed.

See below for an example of what the first six columns of the reference data may look like:

REF_DATA_ID LABEL TYPE REF_ICON REF_COLOR IS_ACTIVE
1 Active Award Status check-circle NULL 1
2 Closed Award Status close NULL 1
22 Hours Item Duration Unit NULL NULL 1
23 Days Item Duration Unit NULL NULL 1
24 Weeks Item Duration Unit NULL NULL 1
57 Award Alert Type NULL NULL 1
58 Line Item Alert Type NULL NULL 1

Document Template reference data table

The AS_AM_R_DOCUMENT_TEMPLATE table stores the document templates needed for the Create Document from Template checklist item. Updating this table allows you to control what document templates are available for business users creating checklists.

See the following table for a description of the fields in the AS_AM_R_DOCUMENT_TEMPLATE table.

Name MySQL Data Type Appian Data Type Description
DOCUMENT_TEMPLATE_ID int(11) Number (integer) The primary key.
DOCUMENT_NAME varchar(255) Text The name of the template that will display to end users.
FILE_TYPE varchar(255) Text The type of document the template is. For example, DOCX or PDF.

See below for an example of what the columns of the required document table may look like.

DOCUMENT_TEMPLATE_ID DOCUMENT_NAME FILE_TYPE
1 Exercise Option Letter Template DOCX
2 COR Appointment Letter Template DOCX

Feedback