User Interface Design

Overview

This page is about configuring the front-end (User Interface) of the HCM Console. It covers settings needed in build scripts, Helm charts, environment files, global configuration JS, and asset storage (S3). These are used to customise look, behaviour, logos, roles, localisation, etc., for different environments (dev, test, production).

MDMS Configuration

To enable and run the Campaign Module in an environment, several MDMS configurations must be added or updated.

1. Citymodule Configuration - Add the Campaign module in citymodule.json. The city module is needed to run the campaign module in an environment:

{
      "module": "Campaign",
      "code": "Campaign",
      "active": true,
      "order": 10,
      "tenants": [
        {
          "code": "mz"
        }
      ]
    },

1. Roleactions Configuration - Define role-action mappings for user access to Campaign services. 🔗 roleactions.json

2. Actions Test Configuration - Configure sidebar actions and service access for users. 🔗 actions-test.json. To enable sidebar actions, add navigationUrl and path:

{
      ```
      "path": "1Campaign.Mycampaign",
      "navigationURL": "/workbench-ui/employee/campaign/my-campaign",
      "leftIcon": "dynamic:EstimateIcon",
      "rightIcon": ""
    }

📌 Refer to the following Action IDs in QA:

• 1528 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777

1. Roles Configuration - Add campaign roles in roles.json.

🔗 roles.json

{
      "code": "CAMPAIGN_MANAGER",
      "name": "Campaign Manager",
      "description": "Campaign Manager"
    }

1. Validation Schemas - Use the schemas below for validating different uploads in the campaign module:

   1. Boundary Schema → For validating boundary sheet uploads 🔗 boundarySchema.json

   2. Facility Schema → For validating facility sheet uploads 🔗 facilitySchema.json

   3. User Schema → For validating user sheet uploads 🔗 userSchema.json

2. Hierarchy Configuration - Define the lowest hierarchy level for boundary selection in campaigns. 🔗 hierarchyConfig.json

DevOps Configuration

In addition to MDMS updates, certain global configurations and Helm charts must be added to ensure the Campaign Module runs properly.

1. Global Configuration -Add the global configuration to the environment file. 🔗 unified-uat.yaml. This ensures the Campaign Module services and UI are available across environments (e.g., UAT, QA, Prod).

2. Helm Chart Configuration - Update the Helm charts for the frontend to include Workbench-UI (used for Campaign workflows). 🔗 Chart.yaml. This defines the Helm deployment setup for the Workbench UI, which powers the Campaign management console.

To understand environment setup and Helm deployments in detail, refer here: 👉 Setup Environment Guide

Localisation

Refer to the different localisation modules to manage screen texts, labels, error messages, and schema headers. For the Campaign Module, the following modules are relevant:

Module	Use
rainmaker-common	For all common screen localisation messages like login, homepage, sidebar
rainmaker-campaignmanager	For all console-related screens localisation messages
rainmaker-hcm-admin-schemas	For all upload schemas like target, facility, user
boundary-${BOUNDARY_HIERARCHY_TYPE}	For boundary type localisations, we get this BOUNDARY_HIERARCHY_TYPE from the MDMS