Configuring Tenants

Overview

A Urban Local Body (ULB) is defined as tenant.

Pre-requisites

Before proceeding with the configuration, the following pre-requisites are met -

• Knowledge of json and how to write a json is required.

• Knowledge of MDMS is required.

• User with permissions to edit the git repository where MDMS data is configured.

Key Functionalities

• For login page city name selection is required. Tenant added in MDMS shows in city drop-down of login page.

• In reports or in the employee inbox page the details related to ULB is displayed from the fetched ulb data which is added in MDMS.

• Modules i.e., TL,PT,MCS can be enabled based on the requirement for tenant.

Deployment Details

1. After adding the new tenant, the MDMS service needs to be restarted to read the newly added data.

Configuration Details

1. Tenant is added in tenant.json.
   In MDMS, file tenant.json, under tenant folder holds the details of state and ULBs  to be added in that state. 
   

   {
     "tenantId": "uk",  //<ReplaceWithDesiredTenantId>
     "moduleName": "tenant",
     "tenants": [ {
         "code": "uk.citya", //<state.ulbname>
         "name": "City A",  //<name of the ulb>
         "description": "City A", //<ulb description>
         "logoId": "https://s3.ap-south-1.amazonaws.com/uk-egov-assets/uk.citya/logo.png",  //<ulb logo path - To display ulb logo on login>
         "imageId": null,
         "domainUrl": "", //<ulb website url>
         "type": "CITY",
         "twitterUrl": null,
         "facebookUrl": null,
         "emailId": "complaints.citya@gmail.com",  //<ulb email id>
         "OfficeTimings": {
           "Mon - Sat": "10.00 AM - 5.00 PM"
         },
   "city": {
   "name": "City A",
   "localName": null,
   "districtCode": "CITYA",
   "districtName": null,
   "regionName": null,
   "ulbGrade": "Municipal Corporation",
   "longitude": 78.0322,
   "latitude": 30.3165,
   "shapeFileLocation": null,
   "captcha": null,
   "code": "248430"
   },
   "address": "City A Municipal Cornoration Address",
   "contactNumber": "91 (135) 2653572"
   }]}

Note: 

• To enable tenant the above data should be pushed in tenant.json file. Here "ULB Grade" and City  "Code" are important fields. ULB Grade can have a set of allowed values that determines the ULB type, (Municipal corporation (Nagar Nigam), Municipality (municipal council, municipal board, municipal committee) (Nagar Parishad), etc). City "Code" has to be unique to each tenant.  This city-specific code is used in all transactions. Not permissible to change the code. If changed we will lose the data of the previous transactions done.

• Naming Convention for Tenants Code

“Code”:“uk.citya” is StateTenantId.ULBTenantName"

• "logoId": "https://s3.ap-south-1.amazonaws.com/uk-egov-assets/uk.citya/logo.png",  Here the last section of the path should be "/<tenantId>/logo.png". If we use anything else, logo will not be displayed on the UI. <tenantId> is the tenant code ie “uk.citya”.

2. Localization should be pushed for ulb grade and ulb name.  Format is given below.
Localization for ULB Grade :

 {
     "code": "ULBGRADE_MUNICIPAL_CORPORATION",
     "message": "MUNICIPAL CORPORATION",
     "module": "rainmaker-common",
     "locale": "en_IN"
  }

  Localization for ULB Name : 

{
     "code": "TENANT_TENANTS_UK_HALDWANI",    
     "message": "Haldwani",
     "module": "rainmaker-tl",
     "locale": "en_IN"
}

Format of localization code for tenant name : <MDMS_State_Tenant_Folder_Name>_<Tenants_Fille_Name>_<Tenant_Code>(replace dot with underscore)

2.Boundary data should be added for the new tenant.

Reference Docs

Doc Links