Objective

The objective of a product UI usage document is to provide guidance and instructions to users on how to effectively use a product's user interface (UI) to change the Logos, Menu Icons, Title & others. 

Ultimately, the goal of a product UI usage document is to help users understand and navigate the product's interface more effectively, improved user satisfaction, and a better overall user experience.

There are 3 configuration files which user can update by there own and redeploy the code to get the changes reflected

• UI Configuration

• Menus Configuration

• Steps to Configure Keycloak after Installation

• Adding users to Keycloak

• Redeployment Steps

The first 2 files are the UI Layer changes  config file and the 3rd configuration file is to make the Metric values changes if required for the user.

Below steps will clearly describe the configuration for 2 files where user can do the minimal changes as specified and re-deploy the code again

• UI Configuration

The UI configuration files can be found in the dashboard-ms microservice. In this UI configuration file ( dashboard-ms > src > assets > config > ui_config.json ) we can modify the Logo name of the application, Header name & title, Dashboard name & title as well. There are certain keys specified respectively in the file to do the changes accordingly. 

If user needs to change any of the values inside the UI config file, they need to go to specified location directory as shown below and do the changes

The images should have the following dimensions: ( Height * Width )

• logoURL - 60px * 60px

• imageURl - 780px * 600px

• dashboard_header2_image1 - 45px * <Any>

• dashboard_header2_image2 - 45px * 45px

• dashboard_header1_image - 32px * 32px

dashboard_header1_title : This key is used to change the title of the cQube application page mentioned on the header 

dashboard_header1_image : This key is used to change the image of the cQube application page mentioned on the header. Need to upload the image into the specified directory dashboard-ms > src > assets > images

dashboard_header2_title : This key is used to change the title of the cQube application state name header title mentioned on the header

dashboard_header2_image1 : This key is used to change the image of the cQube application state mentioned on the header. Need to upload the image into the specified directory dashboard-ms > src > assets > images

dashboard_header2_image2 : This key is used to change the image of the cQube application ncert mentioned on the header. Need to upload the image into the specified directory dashboard-ms > src > assets > images

title : This key is used to change the title in the login page of the application.

imageURL : This key is used to change the side image of the application as shown

tagLine : This key is used to change the tag line specified in the login page of the application.

logoURL : This key is used to change the logo in the login page of the application.

• Menus Configuration

Menus configuration can be changed in the query-builder microservice. In this file (query-builder > menus.csv) users can change the menus sequence, program name etc. They need to add the required details mentioned in the csv to add a new menu into the UI layer. If they add/change any icon for the menu, they need to upload the icon images into the following directory dashboard-ms > src > assets > images

The sample csv filled is shown below,

• Steps to Configure Keycloak after Installation

Step 1 : In a browser go to the <domain>/auth and go to Administration Console.

Step 2 : Enter the keycloak admin username and password that you have set as part of the cQube installation.

Step 3 : Navigate to the Clients Tab of the cQube Realm and select the client (cqube 5.0) created during the installation.

Step 4 : Fill the Valid Redirect URIs with the domain of the application followed by ‘/*’

Step 5 : Fill the Web Origins with the domain of the application

Step 6 : Turn on the Direct Access Grant Enabled and save the changes.

• Adding users to Keycloak

Steps to create an new user

Step 1 : Navigate to Users tab

Step 2 : Click on the add User button

Step 3 : Enter the Username and save.

Step 4 : Navigate to the Credentials tab and Enter the required password, turn off the temporary password option and save.

Adding Bulk Users to the Key-cloak Realm

Step 1 : Navigate to Partial Import tab in manage section

Step 2 : Select import file and upload the json file containing information of users. ( Json File format as shown below)

Step 3 : In the dropdown select overwrite if required to overwrite existing users with the same information.

Or select skip if you want to skip them

Step 4 : After selecting the dropdown according to the need, click import.

Step 5 : Now that the users are imported, will be able to login to the application using the credentials.

• Redeployment Steps

Redeployment Steps of UI config json file changes

Run the below commands one after the other to redeploy the UI config file changes to take effect in Visualization

Redeployment Steps of menus.csv file changes

Run the below commands one after the other to redeploy the menus.csv file changes to take effect in Visualization Sidebar