2. Reference Data Profile

Owned by Jenni Wallin
Last updated: Aug 16, 2023 by Yuri Au Yong
3 min read

In a Reference Data profile configuration, you can select the tables that should be available for query and editing via the Reference Data Management Web UI, or RESTful interface. For information about these interfaces, see the Reference Data Management user's guide.

This profile is loaded when you start the Platform.

To create a new Reference Data profile configuration, click the New Configuration button in the upper left part of the Desktop window, and then select Reference Data Profile from the menu.

To open an existing Reference Data profile configuration, double-click the configuration in the Configuration Navigator, or right-click on the configuration and then select Open Configuration(s)....

General

The General tab is displayed by default.

The Reference Data profile - General tab

SettingDescription

Database

This is the database the agent will connect and send data to.

Click the Browse... button to get a list of all the database profiles that are available. For further information see 8.6 Database Profile. If changes have been made in the selected database, click the Refresh button to retrieve updated db metadata that will be reflected in the table selector when adding entries into the Tables section of the configuration dialog.

The Reference Data profile is supported for use with Derby, Oracle and PostgreSQL databases.

Enable Enhanced Logging

When you perform any of the following operations, entries are written to the System Log, and DB Ref event notifications are generated:

  • Commit changes to the database
  • Perform import operations

Select Enable Enhanced Logging to include information about executed SQL statements in the event notifications.

For more information about DB Ref events, see 4.3.4 DB Ref Event.

Table

This is a table in the selected database.

Read

Select this check box to enable read access to the selected tables. Users of the profile can query and export data.

Write

Select this check box to enable write access to the table data. If Read is also selected, users of the profile can insert, update, delete and import data.

Last Update

Select this check box to enable the Last Update feature. Last Update allows users to specify two columns in the table that will be used to automatically record the username and timestamp of when an entry was updated.

Info!

Manually editing the User and Timestamp column from the Reference Data Management web UI is disallowed.

Info!

When creating tables to include the User column and Timestamp column, ensure that these columns are not UNIQUE and does not have any PRIMARY KEY constraints.

The datatype for the user column should be set as VARCHAR and datatype of the timestamp column should be set as TIMESTAMP.

User ColumnThis is where you can edit the user column name for the Last Update feature.
Timestamp ColumnThis is where you can edit the timestamp column name for the Last Update feature.

To Add a Table 

Note!

Reference Data Management does not support tables that contain a column that has both GENERATED ALWAYS AS IDENTITY and PRIMARY KEY constraints. Having one or the other constraint in a column in your table will not affect Reference Data Management.

Note!

Modifications to a reference data entry are supported either on Oracle (based on ROWID pseudo column) or non-Oracle type tables containing Primary Key constraint. Non-Oracle tables without a Primary Key are not supported for data modifications.

Note!

Reference Data Management does not support the use of case sensitive identifiers.


  1. Click on the Add button.
  2. Select a table from the drop down list.
  3. Always select the Read access check box. If you want to enable editing of the table table, also select the Write access check box.
  4. If you want to enable Last Update, select the Last Update check box. Then fill up the User column and Timestamp column with the column name of your choice.

Advanced

In the Advanced tab, you can configure additional properties. You can use these parameters to tune the performance of database operations.

The Reference Data profile - Advanced tab

Next:
3. Web UI