Configurator UI

With the Configurator UI, you can upload, update, edit, and remove various application properties and configuration values.

Navigating the Configurator UI

Access to the dashboard is controlled through a basic username and password authentication.

To access the Configurator UI from a browser window, perform the following steps:

Note: All the latest versions of Google Chrome, Mozilla Firefox, and Internet Explorer are supported by the Configurator UI.
Note: To start the configurator UI, the configurator and authorization service must be up and running. Also, update the $PSI_HOME/roles/configurator-ui/standalone/config/application.properties file for configuratorServiceUrl and authorizationServiceTokenEndPoint values.

Procedure 

1. Go to http://<host>:<port number> URL to access the Login page, where:
- host is the computer where you have started configurator UI service
- port is the port number of the machine where configurator UI listens for the requests. The default port number is 9104.

2. Enter the credentials in the Username and Password fields and then click LOGIN to sign in.
The Configurator UI dashboard opens.

Uploading Metadata File

Procedure 

1. Click SEEDING to upload the metadata file.
2. Switch the radio button to select Meta on the top right-hand side.
3. To upload the $PSI_HOME/seed-data/application_metadata.json file, use the drag-and-drop function or click CHOOSE META DATA FILE.

Configuring an Application

When you log in for the first time, an empty dashboard opens without any applications. It means the app_properties and configuration tables are blank in the database.

Before you beginBefore configuring an application, you must upload the metadata file.

Procedure 

1. Click SEEDING to upload the user’s data.
2. To select the files, use the drag-and-drop function or click CHOOSE FILES .
3. To view an application property file, click VIEW. The file opens in text editor mode.
The left pane is the editing pane and the right pane is the preview pane.
4. To revert or save the changes, click REVERT or SAVE.
5. To hide or delete the files, click HIDE or DELETE.
6. Finally, click UPLOAD to upload the files.
You can also use the UPLOAD ALL or CLEAR ALL option to upload or remove all the files at once.
ResultOnce the files are uploaded successfully, the available applications are displayed on the left pane.

Note: If the files are uploaded from the Configurator swagger, run the refresh management function on the Configurator server's endpoint (http://<host>:<configurator_port>/management/refresh) to reflect the properties in the Configurator UI. Once this is done, log in again to the configurator UI.

Editing Application Properties

Procedure 

1. Select the required application from the left pane, choose an App properties category row, and click EDIT.


The application properties file for that category opens in an editing pane.
2. To add new properties, click ADD PROPERTY, fill the details in the Property name, Value, and Description fields and select a Value type from the drop-down option. Then click the save icon .
If the property is tenant-specific, you can select the Tenant property check box.

3. Click the edit icon or delete icon to edit or delete application properties.

You can restore the previous property value by clicking on the restore icon .
Note: You can only edit the value and value type of a property.
4. Once editing is completed, click CANCEL.

Replicating Application Properties

Procedure 

1. Log in to the Configurator UI as a non-default tenant.
2. Select the required application from the left pane, choose an App properties category row, and click EDIT.
3. In the Tenant Replication window, enter the Source TenantID and click REPLICATE.
Note: When you log in with the default tenant or any other tenant with no data on the database, the data seeding option is enabled. When you log in with a non-default tenant and the database is not empty, the tenant replicate option is visible.

Editing Configuration Files

Procedure 

1. On the Configuration files tab, click SEEDING to add a configuration file.
2. To view a configuration file, click VIEW next to the respective configuration file.
3. To edit a configuration file, click EDIT.
The file opens in text editor mode. The left pane is the editing pane and the right pane is the preview pane.

4. To discard or save the changes, click REVERT or SAVE.