Boundary Campaign Setup

Boundary Bulk Upload for Campaign

Boundary Bulk Upload Overview:

This documentation outlines the process and components of bulk uploading boundaries for a campaign. It covers the proper format of the Excel sheet, unique code generation, functions for boundary entity creation, boundary relationship creation, localisation, and API details.

Sequence Diagram

Format of Excel for Boundary Bulk Upload

The Excel sheet should be formatted as follows:

Country

Província

Distrito

Posto Administrativo

Localidade

Aldeia

INDIA

KARNATAKA

INDIA

KARNATAKA

BLR

INDIA

KARNATAKA

BLR

KORAMANGALA

INDIA

KARNATAKA

BLR

KORAMANGALA

3RD BLOCK

INDIA

KARNATAKA

BLR

KORAMANGALA

3RD BLOCK

EGOV

INDIA

BIHAR

INDIA

BIHAR

PATNA

Unique Code Generation

Unique codes are auto-generated for each boundary level as follows:

Boundary

Code

INDIA

ADMIN_IN

KARNATAKA

ADMIN_IN_01_KARNATAKA

BLR

ADMIN_IN_01_01_BLR

KORAMANGALA

ADMIN_IN_01_01_01_KORMANGALA

BIHAR

ADMIN_IN_02_BIHAR

PATNA

ADMIN_IN_02_01_PATNA

If there are two districts (boundaries at the same level) with the same name (for example, BLR) under different parent-level boundary, the names will be updated to BLR, BLR-01, and so on.

getAutoGeneratedBoundaryCodes Function

Purpose:

Generate auto-generated boundary codes based on boundary list, child-parent mapping, element codes map, count map, and request information.

Parameters:

boundaryList: List of boundary data.
childParentMap: Map of child-parent relationships.
elementCodesMap: Map of boundaries to its corresponding auto generated unique codes.
countMap: Map of counts for each boundaries.
request: HTTP request object.

Returns:

Updated element codes map.

Steps:

Initialise Column Data:
- Initialise an array to store column data.
Extract Unique Elements:
- Iterate through each row of the boundary list.
- Extract unique elements from each column.
Generate Boundary Codes:
- Iterate over columns to generate boundary codes.
- Check if the element code exists in the element codes map.
- If not, generate a new code based on parent-child mapping and sequence.
- Store the code of the element in the element codes map.
Default Code Generation:
- Generate default code if parent code is not found.
Updated Element Codes Map
Return Updated Boundary Data - Auto-Generated Code Map.

Boundary Entities Creation

Boundary entities are created chunk-wise, with each chunk consisting of 200 codes.

Create Boundary Entities

Purpose:

To create new boundary entities in the system from provided boundary codes.

Steps:

Convert Boundary Map:
- Change the boundary map to a list of objects with key and value.
Prepare Request:
- Set up the request details and initialise lists for boundaries and existing codes.
Chunk Boundary Codes:
- Divide the boundary codes into smaller groups.
Fetch Existing Boundaries:
- Check the system for existing boundary codes and collect them.
Identify New Boundaries:
- Determine which boundary codes are new and add them to the list of boundaries to create.
Create New Boundaries:
- If there are new boundaries, send them to the system in groups and log the results.
Handle Existing Boundaries:
- Log a message if all boundaries already exist.
Error Handling:
- Manage any errors that occur and provide a relevant error message.

Boundary Relationship Creation

`Create Boundary Relationship`

Purpose:

To create boundary relationships in the system from provided boundary codes and their parent-child mappings.

Steps:

Convert Boundary Map:
- Transform the boundary map to a list of {key, value} objects.
Initialise Request:
- Prepare the request details and activity messages array.
Fetch Existing Relationships:
- Retrieve existing boundary relationships and extract their codes.
Identify and Create Relationships:
- For each boundary code, check if it exists. If not:
  - Prepare the boundary relationship data.
  - Confirm the parent boundary creation.
  - Create the boundary relationship.
Handle Existing Relationships:
- If all relationships already exist, log a validation error.
Attach Activity Messages:
- Add activity messages to the request body.
Error Handling:
- Catch, log, and handle errors appropriately.

Localisation Upsert of Codes

Boundary codes are localised to their corresponding names as specified in the uploaded Excel sheet.

Boundary Bulk Upload Upsertion

To add more boundaries after the initial upload, use an Excel sheet that includes existing boundary codes. New boundaries without codes will be created in the same way as the first upload.

API for Boundary Bulk Upload

API request for boundary bulk upload:

bashCopy codecurl --location 'http://localhost:8080/project-factory/v1/data/_create' \
--header 'authority: unified-dev.digit.org' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
--header 'content-type: application/json' \
--header 'cookie: _ga_XBQP06FR8V=GS1.1.1691570094.3.1.1691570094.60.0.0; _ga=GA1.1.2124364284.1689669598; _ga_P1TZCPKF6S=GS1.1.1691648339.2.0.1691648339.60.0.0; __cuid=fe28d9c8c84c4d2487b9cb6c9e4cdec1; amp_fef1e8=f4a3f3ed-50f2-409b-be4f-a1ce1dbb59f2R...1hgs4r9gr.1hgs4robc.nu.1r.pp; _ga_H9YC8FEN6F=GS1.1.1701751656.77.1.1701751677.39.0.0' \
--header 'origin: https://unified-dev.digit.org' \
--header 'referer: https://unified-dev.digit.org/works-ui/employee/measurement/update?tenantId=pg.citya&workOrderNumber=WO/2023-24/000894&mbNumber=MB/2023-24/001252' \
--header 'sec-ch-ua: "Chromium";v="116", "Not)A;Brand";v="24", "Google Chrome";v="116"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "Linux"' \
--header 'sec-fetch-dest: empty' \
--header 'sec-fetch-mode: cors' \
--header 'sec-fetch-site: same-origin' \
--header 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36' \
--data-raw '{
    "RequestInfo": {
        "apiId": "Rainmaker",
        "authToken": "e45445a1-6891-4a76-a4e6-528e1dd24946",
        "userInfo": {
            "id": 1284,
            "uuid": "867ba408-1b82-4746-8274-eb916e625fea",
            "userName": "EMP57",
            "name": "Jagan",
            "mobileNumber": "6667776662",
            "emailId": "xyz@egovernments.org",
            "locale": "string",
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "System Administrator",
                    "code": "SYSTEM_ADMINISTRATOR",
                    "tenantId": "mz"
                },
                {
                    "name": "Campaign Manager",
                    "code": "CAMPAIGN_MANAGER",
                    "tenantId": "mz"
                },
                {
                    "name": "Localisation admin",
                    "code": "LOC_ADMIN",
                    "tenantId": "mz"
                },
                {
                    "name": "MDMS Admin",
                    "code": "MDMS_ADMIN",
                    "tenantId": "mz"
                }
            ],
            "active": true,
            "tenantId": "mz",
            "permanentCity": "Amritsar"
        },
        "msgId": "1710912592752|en_IN",
        "plainAccessRequest": {}
    },
    "ResourceDetails": {
        "type": "boundary",
        "tenantId": "mz",
        "fileStoreId": "be52ce1a-bc25-4328-91bc-a682079abb59",
        "action": "create",
        "hierarchyType": "ADMIN",
        "additionalDetails": {},
        "campaignId": "5d721d03-bdf5-4021-86ff-107e61eb7abb"
    }
}'

Note: Ensure the API endpoint, headers, and payload are customised as per your environment and requirements.

PreviousTarget Upload NextBoundary Generation