Incident Management HLD

Components:

• Frontend (UI):

  • Developed using HTML, CSS, JavaScript, and Angular.

  • Provides a web-based interface for authorized users to access Incident Management functionality.

  • Communicates with the backend through RESTful APIs.

• Backend:

  • Developed using Java 11 and Google Cloud Endpoints framework.

  • Interfaces with other modules within the Eshopbox platform, such as the incident management, importing selected order details, cron for syncing incident with orders etc.

  • Exposes APIs for frontend communication.

  • Implements error handling and logging.

• Database:

  • Utilizes relational (e.g., MySQL) databases for storing incident management information and order mapped with incident.

• Algolia:

  • Adding incident detail keys in Algolia and updating keys while syncing the order.

Figma:

https://www.figma.com/proto/OisG6xsgcr90cUUe2wUZjw/WIP-August-2023-%5B-NS%2BJW%5D?page-id=1599%3A16354&type=design&node-id=2241-17628&viewport=314%2C102%2C0.09&t=P4GTEjXVnVUhxwdD-1&scaling=min-zoom

Repository:

Job type : packages

Sequence Diagram:

Getting list of Incidents:

1. For getting list of incidents, frontend is calling /incidents Api to backend , then incident is requesting incident details from database, then from database it is getting the response from database.

2. We need to categorizing list of incidents as ongoing, upcoming and closed and sending the list of incidents in response to frontend as per this categorization.

Open

Creating Incident :

1. For creating incident, frontend is calling /incidents Api to backend , and on the basis of services affected it is filtering the list of orders from the database.

2. Backend is updating the incident as per the details given by actor in database, and then it is mapped with order items in database according to affected area type.

3. Status of incident is displaying according to to_date and from_date coming from frontend .

4. Then event is published by backend in order to update the details in algolia.

5. After then status of response is send to the frontend.

Open

Opening or Editing Incident Page:

1. For opening for editing incident page, we need to add details of incident, before that some of the request need to be made from frontend.

2. Frontend need to get the details of services affected from backend.

3. Frontend need to fetch the affected areas details as under:

   1. For list of selected states, cities , frontend need to get details from esb-client-portal-prod , which will get details from database.

   2. For list of Eshopbox FC’s , frontend need to call the external API to get the detail of eshopbox FC’s.

   3. For list of pincodes, orderItems , frontend need to upload the list of pincodes, orderItems in CSV format. Then frontend will call list of Valid and Invalid pincodes/ orderItems to backend and then backend will fetch details from database and send response to frontend having list of valid and invalid pincodes/ orderItems.

4. As all the details are prepared from point 3, the user will able to get details in second dropdown of affected areas while selecting the first dropdown of affected areas.

Open

Closing Incident :

1. For closing the incident, user need to click on Take action button then it need to click on close button.

2. Frontend will then call /closeIncident API and will update the status of incident in database and will then update the status in the order item level in Algolia.

Open