Page Comparison

Overview

The main objective of the Fire-NOC module is to provide No Objection Certificate indicating that the building is designed as per fire safety norms and regulation.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Prior knowledge of JavaScript.

• Prior knowledge of Node.js platform.

• Kafka server is up and running

• JSONPath for filtering required data from json objects.

• Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

• egov-persister service is running and has firenoc-services persister config path added in it

• PSQL server is running  and database is created

• Prior knowledge of eGov-mdms service, eGov-persister, eGov-user,  eGov-location, eGov-localization, eGov-idgen.

Key Functionalities

• Used for No Objection Certificate generations indicating that the building is designed as per fire safety norms and regulation.

• Generate application number and fire noc number

• Support workflow

• Provide notification on various status changes for an application

Interaction Diagram

To Do

Deployment Details

1. Add mdms configs required for firenoc service and restart mdms service.

2. Deploy the latest version of firenoc-services service.

3. Add firenoc-services persister yaml path in persister configuration and restart persister service.

4. Add Role-Action mapping for API’s.

5. Create businessService (workflow configuration) according to firenoc registration.

Configuration Details

Following are the properties in application.properties file in trade firenoc-service which are configurable.

...

https://github.com/egovernments/egov-services/blob/noc/core/egov-idgen/src/main/resources/db/migration/main/V20190517152600__create_fn_sequence_ddl.sql

API Details

BasePath /firenoc-services/v1/[API endpoint]

Method

a) _create

Create API call is called with INITIATED action to create new application. In this API call we validate request body(using ajv module for contract specific validation and explicit checking for user related validation checks), enrich audit details, generate application no using idgen, persist data using persister and return response.

...

Allowed user roles: NOC_CEMP, CITIZEN, NOC_DOC_VERIFIER, NOC_FIELD_INSPECTOR, NOC_APPROVER, EMPLOYEE

Integration 

Integration Scope

The Fire-Noc service is use to provide No Objection Certificate indicating that the building is designed as per fire safety norms and regulation.

Integration Benefits

• Provide backend support for the No Objection Certificate registration process for different building.

• SMS notifications on application status changes.

• Supports workflow which is configurable

Steps to Integration

To integrate, host of firenoc-services service should be overwritten in helm chart.

1. firenoc-services/v1/_createshould be added as the create endpoint for creating fire noc application in the system.

2. firenoc-services/v1/_search should be added as the search endpoint .This method handles all requests to search existing records depending on different search criteria.

3. firenoc-services/v1/_update should be added as the update endpoint. This method is used to update fields in existing records or to update status of application based on workflow.

Reference Docs

Doc Links

API List

...