Organisation

Organisation registry to store vendors, contractors, CBOs and other org types.

Overview

The organisation service is a generic registry to store all types of organisations. This includes vendors, contractors, community based organisations in the Works domain. This registry stores information about an organisation including their contact details, tax identifiers, areas of work and other relevant information.

Pre-requisites

Below services need to be running in the environment for the organisation registry to function as expected:

• Persister

• Indexer

• User

• Individual

• MDMS

• Access Control

• Notification

• IDGen

• Filestore

Functionality

Provides APIs to create, update and search an organisation's details. As part of organisation creation, it also creates a system user who can log into the DIGIT system and perform actions on behalf of the organisation. The contact person details are used to create the user with a CITIZEN role and an OTP based login.

Deployment

The Helm chart for this service is configured here.

MDMS Configuration

Configure roles, actions and role-actions per the table below by following steps here.

Roles	API Endpoints
WORK_ORDER_CREATOR MUKTA_ADMIN	/org-services/organisation/v1/_search
MUKTA_ADMIN	/org-services/organisation/v1/_create
MUKTA_ADMIN	/org-services/organisation/v1/_update

Persister

Make sure organisation-persister.yml is present in the configs repo under the egov-persister directory.

Indexer

Please make sure that the file organisationservices-indexer.yml is present in the configs repo under the egov-indexer directory.

ID generation

The following ID formats are configured for the Organisation service under the common-masters directory, IDFormat.json file. Make sure these are present in the file.

   {
      "format": "ORG-[SEQ_ORG_NUM]",
      "idname": "org.number"
    },
    {
      "format": "SR/ORG/[cy:dd-MM-yyyy]/[SEQ_ORG_APP_NUM]",
      "idname": "org.application.number"
    },
    {
      "format": "SR/FUNC/[cy:dd-MM-yyyy]/[SEQ_FUNC_APP_NUM]",
      "idname": "function.application.number"
    }

SMS Templates

SMS templates have to be configured with the service provider to send notifications to users. Current SMS template configurations are as follows:

  {
           "code": "ORGANISATION_NOTIFICATION_ON_CREATE",
           "message": "Dear {individualName}, You have been registered as the contact person of {organisationName} on MuktaSoft, Organisation ID {ID}. To login please click on {cbo_portal_url}. Contact Mukta Coordinator for more details.",
           "module": "rainmaker-common-masters",
           "locale": "en_IN"
       },


       {
           "code": "ORGANISATION_NOTIFICATION_ON_UPDATE",
           "message": "Dear {contactpersonname}, The organization details has been updated on your request. Please contact the MUKTA Coordinator if you have not made this request. To login please click on {cbo_portal_url}.",
           "module": "rainmaker-common-masters",
           "locale": "en_IN"
       }

Integration

Download the Postman collection for this service and test the APIs against a DIGIT server.