The Reference Data Management Dashboard This section will refer to the Reference Data Management dashboard found on the Desktop and all relevant materials and functions associated with the dashboard. The Reference Data Management dashboard will allow you to do the following:
Query the results from a table based on the Reference Data Management profiles in the system
Filter certain results by using expressions in your query
Insert new rows in your table
Edit existing fields in your query results (For unsupported data types, please refer to <TODO>)
Import existing data from a CSV file
Export the entire table or queried result into a CSV file
You can access the dashboard from the Manage View. Go to Manage → Data Management and then select Reference Data Management.
| Note |
|---|
Note! Temporary files are created on the Platform host when the user executes queries via Reference Data Management. These temporary files, stored in |
...
Click on Get Started to begin Querying a table resultquerying. You can refer to the Steps to query a result for more information.
Furthermore, you can use these links to navigate to the information you need when working with the dashboard:
| Table of Contentschildren | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Querying a table result
To query a table, you will use the Get Started button from the initial dashboard page or you can click on the Query button on the result view.
...
| Rw step |
|---|
On the Query dialog, choose a Reference Data Profile by clicking on the Browse button. Look for and select the profile that has the tables you want to search from using the Select Reference Data Profile dialog. For more on Reference Data Profiles, you can refer to Reference Data Profile.
...
| Rw step |
|---|
Select a table from the dropdown list. The tables configured in the Reference Data Management profile will appear here.
...
| Rw step |
|---|
Inserting new data into the table
Editing an existing field in the table
Importing from a file into the table
Exporting from the table
Menu Bar
...
Query Result View
Once you have gotten a query result, the status bar above the toolbar will display query configuration information. The status bar summary will contain selected Reference Data Profile and Table, and if Last Update feature is enabled, the most recent Last Update user and datetime. Click on the status bar to reveal the list of query expressions applied for the query result.
Subject to user permission settings that is configured via the Reference Data Profile and Access Controller, appropriate table toolbar buttons will be enabled above the query result view. This bar allows you to select from the tabs, the operations that you will want to use Reference Data Management for, such as Query, Edit and Export/Import. There is also a logout button to log you out of the web UI.
...
Status Bar
A status bar is available after the menu bar. This bar indicates the selected Reference Data profile, selected table, and status of ongoing processes.
The processes that are responsible for performing the various database operations can be time consuming. However, these are performed in the background and do not interfere with the Web UI.
The following controls are available in the status bar:
...
Item
...
Description
...
Refresh State Interval
...
Use this field to set the status line refresh interval in seconds.
...
Refresh State
...
Click on this button to refresh the status line.
...
Stop
...
Click on this button to stop the active process.
Main Tab
You can select the Reference Data profile and table that you want to work with from the Main tab.
...
Web UI - Main tab
When you have selected the table that you want to work with, click Next to perform a query, or select one of the tabs.
Query Tab
In the Query tab you can configure:
Row select conditions
How results are displayed
How data is retrieved (size of the data sets)
...
Setting
...
Description
...
Column
...
This is a column in the selected database table.
...
Operator
...
This is a comparison operator that is applied to the values in the specified column and the value.
The available operators are:
=
!=
like
not like
>
>=
<
<=
between
...
Value
...
This field contains a value that is used in the expression. When between is the selected operator, two value fields are displayed.
You can use SQL wildcards such % and _ with the operators like and not like.
An underscore (_) in the pattern matches exactly one character (as opposed to one byte in a multibyte character set) in the value.
A percent sign (%) in the pattern can match zero or more characters (as opposed to bytes in a multibyte character set) in the value. The pattern '%' cannot match a null.
...
Grid Page Size
...
The value in this field controls the grid size i e the number of rows that the grid will occupy.
...
Data Set Size
...
The queried data is fetched from the Platform in data sets of configurable size. A large size typically results in a faster query but it may take longer to display the first dataset.
The value in this field controls the maximum size of the retrieved data sets.
If a retrieved data set does not fit in the grid, it is paginated.
Single data set can be filtered or navigated by pages within grid. You can navigate the data sets by using the buttons Next Data Set and Previous Data Set.
...
Choose Columns
...
This button open the Choose Columns dialog. Use this dialog to select the columns that should be displayed in the result of the query.
...
Execute Query and Show Result
...
Executes the query and opens the Edit tab.
| Note |
|---|
Database operations are performed asynchronously (in the background) and you can update available data while a query process is still running. |
To Execute a query:
Select a column that you want to use in the condition.
Select a comparison operator.
Enter a value for the condition.
Use the
and
buttons to add more conditions to the expression, or remove an existing one. When there are multiple expressions, these are combined by AND logic.
Change the Options settings to values that are suitable for the queried table.
Click the Choose Columns button. Uncheck the column names that you do not want to display in the result and click the OK button.
Click Execute Query And Show Results. The Edit tab containing a data grid is displayed. The data grid is displayed when the application has retrieved the first data set. The subsequent data sets are retrieved in a background process that you can monitor in the status bar.
Edit Tab
In the Edit tab you can:
...
Filter table data
...
Select columns to display
...
Change sorting order
...
Web UI - Edit tab
...
Item
...
Description
...
Select All
...
This button selects all the displayed rows.
...
Clear All
...
This button clears the selection of all rows.
...
Toggle Filtering
...
This button opens a text box above each column label. You can use this text box for filtering rows.
...
Show Only Modified/Show All
...
This button toggles filtering of unedited rows.
...
Export/Import
...
This button opens the Export/Import tab.
...
Columns
...
This button opens a dialog where you can select columns to display.
...
Pagination Control
...
The pagination control is displayed if there is more than one page for the data set. You can use this control to navigate between pages.
...
Previous Data Set
...
This button is displayed if there any previous data sets.
...
Next Data Set
...
This button is displayed if there any consecutive data sets.
...
Insert
...
This button opens a dialog where you can insert rows.
...
Update
...
This button opens a dialog where you can edit selected rows.
...
Delete
...
This button opens a dialog where you can delete selected rows.
...
Cancel Selected
...
This button cancels changes on the selected rows.
...
Cancel All
...
This button cancels all changes.
...
Review
...
This button opens a page where you can display all your edits and commit the changes to the database.
To insert a row:
...
Click commit.
To update rows:
Alternative A:
...
Alternative B:
...
Select one or more rows by either clicking on the check boxes on the leftmost side of the table or the Select All button.
...
Edit the field values.
...
Use the paginator control to navigate between the selected rows.
...
Click Commit.
To delete a row:
...
Click Commit.
Export/Import Tab
In the Export/Import tab you can bulk load data to and from the database.
...
Item
...
Description
...
Export
...
This button start starts an export.
...
Separator Character
...
This field specifies the character that will be used for separating values in the export.
...
Export All Rows
...
When this radio button is selected, all rows in the table will be exported.
...
Export Retrieved Rows
...
When this radio button is selected, the rows in the last query will be exported.
...
CSV Format
...
This radio button is always selected as data must be exported in CSV format.
...
Column Selector
...
This button open the Choose Columns dialog. Use this dialog to select the columns that should exported.
To export a table:
...
Click Export. The data is exported to the file <schema name>.<table name>.csv .
...
Item
...
Description
...
Upload File
...
This button opens a file selection dialog. You can only select one file at a time but it is possible to upload multiple files for import. Each added file is listed below the button.
...
Import
...
This button starts the import of the selected file.
...
Abort
...
This button aborts the import of the selected file.
...
Remove
...
This button removes the selected file.
...
Text Qualifier Character
...
This field specifies the character that should be interpreted as the indicator to the text content for a particular field. The character for text qualifier is configurable between single quotes or double quotes. The default text qualifier are double quotes
...
Separator Character
...
This field specifies the character that should be interpreted as separator between values in the imported file. The default separator is a comma.
...
Ignore Error during Import
...
When this check box is selected, errors during import are logged but does not interrupt the process.
...
Append
...
When selected, all rows to be imported into the table will be appended into the table as new rows.
...
Truncate
...
When selected, all rows in the existing table will be truncated and the rows will be imported into an empty table.
To import a table:
...
Click Upload file and select a CSV file. The contents of the file must be consistent with the columns and constraints of the selected table. You can repeat this step to import multiple files.
...
Enter Separator Character that is consistent with the selected files.
...
If a partial import is acceptable select the check box Continue On Error.
...
searching for specific data in the columns, Insert Row, Refresh, Export, Import and Delete.
At the bottom of the view, you get the Previous Data Set and Next Data Set buttons at the footer bar to switch between data sets. The footer also displays data set information and the total of rows for the entire query result. The data set buttons and information are only available if the query result total rows exceeds the Data Set Size(configurable in the Query dialog).
...
Status Bar
Status | Description |
|---|---|
Current Profile | Reference Data Profile selected in the Query dialog. |
Current Table | Table selected in the Query dialog. |
Last Update User | If Last Update feature is enabled for this table in the Reference Data Profile, the name of the most recent user to perform an operation on a record is displayed. |
Last Update Datetime | If Last Update feature is enabled for this table in the Reference Data Profile, the most recent datetime an operation is performed on a record is displayed. |
Query Expressions | Click on the status bar to reveal the list of query expressions configured in Query dialog if any. |
Table Toolbar Options
Options | Description |
|---|---|
Query | Opens the Query dialog, allowing you to tweak with the expressions or query configurations. Refer to Querying A Table In Reference Data Management for more information. |
Search Bar | Filter the current data set to display rows that have any column values that is matching the search barinput. The matched row count is displayed on the right within the search bar. |
Insert Row | Opens the Insert Row dialog for you to add more rows of data into your table. Refer to Inserting rows for more information. |
Refresh | Triggers a query from the Database with the current query configurations and refreshes the query result view with the retrieved updates if any. |
Export | Exports the query result view or the entire table into a file. Refer to Exporting data for more information. |
Import | Imports bulk data from a file into the table. Refer to Importing data for more information. |
Delete | Marks all rows in the data set for deletion. Refer to Removing rows for more information. |
Footer Bar
Options | Description |
|---|---|
Previous Data Set | Switches to the previous data set of the query result. |
Next Data Set | Switches to the next data set of the query result. |
Data Set Information | Shows the current data set number, the data set count and the value of Data Set Size configured in Query dialog. |
Total Row Count | Shows the number of rows that are in the query result. |
| Note |
|---|
Note! When switching between data sets, any uncommitted changes will be discarded. |