Boundary Data Management

This page allows user to create new Boundary and edit it

Boundary Management works based on the HierarchySchema

Refer this config section to know more

Currently, the default hierarchy name is taken from "type": "default", while the hierarchy where data can be created or edited is defined by "type": "campaign".

The landing page of Boundary Management Screen has three buttons

If the boundary has yet not created then the edit boundary field will be disabled

And clicking on create will ask to use default boundary and data from GeoPoDe or create a complete new one.

Using data from GeoPoDe will load the default boundary and ask to add levels

Creating complete new data will require addition of all levels manually

After creation the levels cannot be edited.

Following API’s are called after clicking the Create button:

1. Upsert: /localization/messages/v1/_upsert all the names of level localised in to new module named hcm-boundary-${hierarchyName}

2. Create: /boundary-service/boundary-hierarchy-definition/_create

3. Download: /project-factory/v1/data/_download A polling mechanism is introduced here which keeps on calling the above api until the status is “completed”

4. Create: /project-factory/v1/data/_create Data create api called if it’s a new hierarchy and here also a polling mechanism is installed which calls the api /project-factory/v1/data/_search continuously at a fixed interval until the status is “completed”

It will automatically redirect to the view hierarchy screen after successful creation. If any level matches with the default hierarchy then it will use its data. Complete excel sheet can be uploaded for all levels all together after downloading the template and uploading it. (The image below is just for reference and levels can vary)

After uploading the excel user can go to next page and view data and confirm it.

Submitting next will create the data.

Submitting next will create the data.

Edit boundary tab on first boundary page will also land to view hierarchy page as of now and will allow to add new data. View all Boundary data will show all hierarchies and user can download the hierarchies too.

Following API is called after clicking “Create Boundary”:

1. Create: /project-factory/v1/data/_create the uploaded data in excel is sent to data create api with polling mechanism applied. The search API /project-factory/v1/data/_search is called repeatedly with frequency depending on the size of data and network latency taken from the mdms data using master name “baseTimeout” from module named HCM-ADMIN-CONSOLEuntil status is “completed”.

API Details

Action	Role
project-factory/v1/data/_create	BOUNDARY_MANAGER
project-factory/v1/data/_search	BOUNDARY_MANAGER
project-factory/v1/data/_download	BOUNDARY_MANAGER
localization/messages/v1/_upsert	BOUNDARY_MANAGER
boundary-service/boundary-hierarchy-definition/_create	BOUNDARY_MANAGER
boundary-service/boundary-hierarchy-definition/_search	BOUNDARY_MANAGER
boundary-service/boundary-relationships/_search	BOUNDARY_MANAGER