3. Web UI

Owned by Jenni Wallin
Aug 02, 2021
8 min read

You can use the Web UI to query, edit, import, and export data in database tables specified by Reference Data profiles in the system.

The Web UI is available at:

http://<Platform host>:<port>/ref/

If encryption is enabled, the URL is https://<Platform host>:<port>/ref/. For further information about enabling encryption, see 4. Network Security in the System Administration user's guide.

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.

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.


You are now required to login using the login page for Reference Data Management. Just key in your user credentials as defined in the  access control and click on sign in to proceed to the main screen.

Web UI - Login screen

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:

ItemDescription

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)




Web UI - Query tab


SettingDescription
ColumnThis 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.

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:

  1. Select a column that you want to use in the condition.

  2. Select a comparison operator.

  3. Enter a value for the condition.

  4. 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.

  5. Change the Options settings to values that are suitable for the queried table. 

  6. Click the Choose Columns button. Uncheck the column names that you do not want to display in the result and click the OK button.
  7. 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:

  • Edit, delete, and insert rows
  • Filter table data
  • Select columns to display
  • Change sorting order





Web UI - Edit tab


ItemDescription
Select AllThis button selects all the displayed rows.
Clear AllThis button clears the selection of all rows.
Toggle FilteringThis 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/ImportThis 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 SetThis button is displayed if there any previous data sets.
Next Data SetThis button is displayed if there any consecutive data sets.
InsertThis button opens a dialog where you can insert rows.
UpdateThis button opens a dialog where you can edit selected rows.
DeleteThis button opens a dialog where you can delete selected rows.
Cancel SelectedThis button cancels changes on the selected rows.
Cancel AllThis button cancels all changes.
ReviewThis button opens a page where you can display all your edits and commit the changes to the database. 


To insert a row:

  1. Click the Insert button. The Data Editor dialog opens.

  2. Fill out the form in the dialog and click Apply Changes and Exit.

  3. Click Review. All the pending changes are displayed.

  4. Click commit.
     

To update rows:

  1. Alternative A:
    1. Click on the cells in the grid that you want to edit and update the value.

  2. Alternative B:
    1. Select one or more rows by either clicking on the check boxes on the leftmost side of the table or the Select All button.
    2. Click the Update  button. The Data Editor dialog opens.

    3. Edit the field values.
    4. Use the paginator control to navigate between the selected rows.
    5. Click Apply Changes And Exit.

  3. Click Review. All the pending changes are displayed.

  4. Click Commit. 

To delete a row:

  1. Select one or more rows by either clicking on the check boxes on the leftmost side of the table or the Select All button.

  2. Click the Delete button. The Data Editor dialog opens.

  3. Use the paginator control to navigate between the selected rows.

  4. Click Apply Changes And Exit.

  5. Click Review. All the pending changes are displayed.

  6. Click Commit. 

Export/Import Tab

In the Export/Import tab you can bulk load data to and from the database. 

ItemDescription
ExportThis button start starts an export.

Separator Character

This field specifies the character that will be used for separating values in the export.
Export All RowsWhen this radio button is selected, all rows in the table will be exported.
Export Retrieved RowsWhen this radio button is selected, the rows in the last query will be exported.
CSV FormatThis 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:

  1. Enter Separator Character.

  2. Select Export All Rows.

  3. Click Export. The data is exported to the file <schema name>.<table name>.csv .
ItemDescription
Upload FileThis 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 CharacterThis 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 ImportWhen this check box is selected, errors during import are logged but does not interrupt the process.
AppendWhen selected, all rows to be imported into the table will be appended into the table as new rows.
TruncateWhen selected, all rows in the existing table will be truncated and the rows will be imported into an empty table.


To import a table:

  1. 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.

  2. Enter Separator Character that is consistent with the selected files.

  3. If a partial import is acceptable select the check box Continue On Error.

  4. Click the Import button for each file that you want to import.