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 |
|---|
Temporary files are created on the Platform host when the user executes queries via Reference Data Management. These temporary files, stored in $MZ_HOME/tmp/rowset, are removed automatically when the user session expires. Users sessions expire automatically after six (6) hours. |
| Note |
|---|
For Oracle Database Users!For Oracle database, the CLOB datatype is not supported by the Reference Data Management. You will be unable to view the contents of a CLOB datatype. |
When you click on the Reference Data Management button a page will appear that looks like this.
...
Click on Get Started to begin querying. 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 Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Rw tab | ||
|---|---|---|
|
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. A Query dialog will open where you will configure the criteria for your query.
...
Options
...
Description
...
Reference Data Profile
...
Allows you to select a Reference Data profile that contains the table you want to query from. For more on Reference Data profiles, you can refer to Reference Data Profile.
...
Table
...
A dropdown list of tables configured in the selected Reference Data profile. You select from one table in the list to perform your query on.
...
Show Columns
...
This option appears once you have selected a profile and a table. This displays all the column names available in the selected table. You can remove and add the columns at your choosing to be displayed in the query result. Clicking on the All button will select all the columns in the table.
All columns are selected by default.
...
Data Set Size
...
This option appears once you have selected a profile and a table. The value in this field controls the maximum size of the retrieved data sets. 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.
...
Query Expressions
...
This option appears once you have selected a profile and a table. Query Expressions allow you to filter the query results according to the criteria you configure in this option. Click on New Expression to add one to the query.
Query Expressions
...
Options
...
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:
equals
not equals
like
not like
greater than
greater than or equals
lesser than
lesser than or equals
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.
Steps to Query a result
...
| 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.
...
| Rw step |
|---|
Select a table from the Table 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
A menu bar is available at the top of the Web UI. This bar allows you to select from the tabs, the operations that you will want to use Reference Data Management, 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)
...
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 |
|---|
Temporary files are created on the Platform host when the user executes queries via Reference Data Management. These temporary files, stored in $MZ_HOME/tmp/rowset, are removed automatically when the user session expires. Users sessions expire automatically after six (6) hours. |
| Note |
|---|
For Oracle Database Users!For Oracle database, the CLOB datatype is not supported by the Reference Data Management. You will be unable to view the contents of a CLOB datatype. |
When you click on the Reference Data Management button a page will appear that looks like this.
...
Click on Get Started to begin querying. 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 Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. A Query dialog will open where you will configure the criteria for your query.
...
Options | Description |
|---|---|
Reference Data Profile | Allows you to select a Reference Data profile that contains the table you want to query from. For more on Reference Data profiles, you can refer to Reference Data Profile. |
Table | A dropdown list of tables configured in the selected Reference Data profile. You select from one table in the list to perform your query on. |
Show Columns | This option appears once you have selected a profile and a table. This displays all the column names available in the selected table. You can remove and add the columns at your choosing to be displayed in the query result. Clicking on the All button will select all the columns in the table. All columns are selected by default. |
Data Set Size | This option appears once you have selected a profile and a table. The value in this field controls the maximum size of the retrieved data sets. 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. |
Query Expressions | This option appears once you have selected a profile and a table. Query Expressions allow you to filter the query results according to the criteria you configure in this option. Click on New Expression to add one to the query. |
Query Expressions
...
Options | 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: |
|
|
>
>=
<
<=
| |
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.
...
Steps to Query a result
| Rw ui steps macro | |||||
|---|---|---|---|---|---|
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.
Select a table from the Table dropdown list. The tables configured in the Reference Data Management profile will appear here.
Choose the columns you will want to view in the query results and configure the maximum data set value should you require it to be set to a different number.
You can also add query expressions to refine the result of the query by filtering out certain data. If you did not configure any expressions, the entire table (up to the number set in the data set value) will be displayed.
Click on Apply and the result will be shown in a view. From this view, you can then query again, insert a new row, edit the fields in the view, delete rows, refresh the view, export the data set, export the entire table or import from data from a CSV file.  |
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
A menu bar is available at the top of the Web UI. This bar allows you to select from the tabs, the operations that you will want to use Reference Data Management, 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. |
Edit Tab
In the Edit tab you can:
Edit, delete, and insert rows
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 the Insert button. The Data Editor dialog opens.
Fill out the form in the dialog and click Apply Changes and Exit.
Click Review. All the pending changes are displayed.
Click commit.
To update rows:
Alternative A:
Click on the cells in the grid that you want to edit and update the value.
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.
Click the Update button. The Data Editor dialog opens.
Edit the field values.
Use the paginator control to navigate between the selected rows.
Click Apply Changes And Exit.
Click Review. All the pending changes are displayed.
Click Commit.
To delete a row:
Select one or more rows by either clicking on the check boxes on the leftmost side of the table or the Select All button.
Click the Delete button. The Data Editor dialog opens.
Use the paginator control to navigate between the selected rows.
Click Apply Changes And Exit.
Click Review. All the pending changes are displayed.
Click Commit.
Export/Import Tab
In the Export/Import tab you can bulk load data to and from the database.
...