Residential Construction Permit Inbox v2 Migration

Steps to migrate to Inbox v2

The following configurations are required to implement Inbox V2 in the Residential Construction Permit module:

1. Indexer Configuration:

   1. Analyse the data used in the inbox page and update the index mapping

   2. Add new indexer configuration with all required as per above for bpa-service

   3. Configure the newly added OBPAS indexer file in the indexer DevOps configuration.

   4. Push Data to Inbox Topics - The processInstance field is mandatory in the payload. The process instance needs to be enriched in the BPA request before pushing it into the inbox topic.

   5. Ensure that the service pushes data to the relevant inbox topics.

   6. Trigger at All Action Points - These steps should be followed during both create and update actions (at all action times).

2. MDMS Configuration:

   1. Configure MDMS to specify all search parameters required to fetch results.

3. Re-indexing for Existing Data:

   1. If data already exists in the current environment, re-indexing is required.

4. Service Configuration:

   1. Apply Code Changes - Review and apply the code changes as per the following commit: Commit Link

5. Update MDMS Configuration

   1. Add the Inbox Search Configuration at the following path: Reference path for correct MDMS data: InboxConfiguration.json at UNIFIED-QA

   2. Restart the MDMS Service after updating the configuration

6. DevOps Configuration - Indexer Service

   1. Add the file path to the environment configuration -

      1. Update the environment configuration file to include the path for the BPA Inbox Indexer configuration.

         1. Add the following line to your environment file - file:///work-dir/configs/egov-indexer/bpa-inbox-indexer.yml

            1. Reference Example: You can refer to the following for the correct format: Unified QA Environment Example

   2. Restart the Indexer Service - After adding the file path, restart the Indexer service to apply the changes: