Resource Upload Details
The resource upload details consists of 3 types of uploads:
Upload Target Data
Facility Upload
User Upload
Upload Summary
1. Upload Target Data
This screen will come after a user selects the boundaries.
When a user clicks on the download template button, an Excel will get downloaded which will contain readMe, Boundary Data sheet along with the sheets with districts, where the user has to fill the target at the lowest level. After the file is uploaded, it will go for validation. Once validated, a user can go to the next page, where the user can delete the file and move to the next page to upload facility date.
2. Upload Facility Data
This screen will come after the target upload screen.
In this screen, when a user clicks on the download template, an Excel gets downloaded containing readMe, Facility sheet, and BoundaryData sheet. A user has to fill in the boundary codes and from that sheet, the user has to fill in the facility sheet.
3. Upload User Data
This screen will appear after the facility details screen.
When a user clicks on the download template, an Excel file gets downloaded that consists of readMe, User Sheet, and BoundaryData. The user has to fillout the user sheet only.
All the 3 downloads are happening through the Generate and Download APIs. For the Generate API, the following hook is used: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/hooks/useGenerateIdCampaign.js
This hook will return the ID which is stored in the local storage according to the type:
HCM_CAMPAIGN_MANAGER_UPLOAD_IDNext, /project-factory/v1/data/_download is used to download the template.
4. Summary
This screen displays all the files which were uploaded in the previous screens, Validation in this screen -
All the 3 files are mandatory to upload in this step otherwise the user is not allowed to move to the next step.
Schema Validation
After uploading the templates, UI validation is done through schema stored in the MDMS: Schema Data link: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/hcm-admin-console/adminSchema.json
Schema Module = adminSchema Below is the admin schema-
"SchemaDefinitions": [
{
"id": "92fb3b53-adfe-44e9-ab27-da3209b5e0f1",
"tenantId": "mz",
"code": "HCM-ADMIN-CONSOLE.adminSchema",
"description": null,
"definition": {
"type": "object",
"title": "Comprehensive Example Schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"$schema",
"title",
"campaignType"
],
"x-unique": [
"title",
"campaignType"
],
"properties": {
"title": {
"type": "string"
},
"$schema": {
"enum": [
"http://json-schema.org/draft-07/schema#"
],
"type": "string",
"default": "http://json-schema.org/draft-07/schema#"
},
"properties": {
"type": "object",
"properties": {
"enumProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"isUnique": {
"type": "boolean"
},
"hideColumn": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"description": {
"type": "string"
},
"orderNumber": {
"type": "integer",
"minimum": 1
},
"errorMessage": {
"type": "string"
},
"freezeColumn": {
"type": "boolean"
}
},
"minProperties": 1
},
"minItems": 1
},
"numberProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"number"
],
"type": "string"
},
"maximum": {
"type": "number"
},
"minimum": {
"type": "number"
},
"isUnique": {
"type": "boolean"
},
"hideColumn": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"multipleOf": {
"type": "number"
},
"description": {
"type": "string"
},
"orderNumber": {
"type": "integer",
"minimum": 1
},
"errorMessage": {
"type": "string"
},
"freezeColumn": {
"type": "boolean"
},
"exclusiveMaximum": {
"type": "boolean"
},
"exclusiveMinimum": {
"type": "boolean"
}
},
"minProperties": 1
},
"minItems": 1
},
"stringProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"pattern": {
"type": "string",
"format": "regex"
},
"isUnique": {
"type": "boolean"
},
"maxLength": {
"type": "integer",
"minimum": 0
},
"minLength": {
"type": "integer",
"minimum": 0
},
"hideColumn": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"description": {
"type": "string"
},
"orderNumber": {
"type": "integer",
"minimum": 1
},
"errorMessage": {
"type": "string"
},
"freezeColumn": {
"type": "boolean"
}
},
"minProperties": 1
},
"minItems": 1
},
"additionalProperties": {
"type": "boolean"
}
},
"additionalProperties": false
},
"campaignType": {
"type": "string"
}
},
"description": "A simplified JSON Schema example based on data type.",
"additionalProperties": false
},
"isActive": true,
"auditDetails": {
"createdBy": "8b110055-330f-4e7b-b4c0-f618f29b9d47",
"lastModifiedBy": "8b110055-330f-4e7b-b4c0-f618f29b9d47",
"createdTime": 1718169189364,
"lastModifiedTime": 1718169189364
}
}
]By using AJV Validation , we are validating the headers of the facility sheet. We are also doing some basic validations for the data such as-
Facility Type can only be Warehouse/Health Facility
Facility Name can only be string
Facility Status can only be Temporary or Permanent etc.
Apart from this, we are also validating (v0.3.1):
Sheet Names: Ensuring the sheet names in all three uploads match the expected values.
Template Locale: The uploaded template should be in the same locale in which it was generated.
Campaign ID: The campaign ID in the upload must match the campaign ID for which the template was generated. This validation is conditional and can be toggled at the DevOps level.
For target validation, we use schema only for validating the header of the target and boundary codes. Here, we also validate the target at the lowest level, where the value should be between:
targetValue <= 0 || targetValue >= 100000000Validation API Call:
Before calling we are using base time out which is fetched from the MDMS
For more information on this schema, you can refer to:
ConfigurationReference Links:
For the backend validation, we use the following hook: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/hooks/useResourceData.js
The screens are using the given below components for upload and validation-
Preview component: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/components/XlsPreview.js
API Details
/project-factory/v1/data/_download
CAMPAIGN_MANAGER
Params will be different for different types- 1) boundary tenantId:mz
type:boundary
hierarchyType:ADMIN
id:987eadc3-55a0-4553-925d-bf8087f57e5a 2) facilityWithBoundary tenantId:mz
type:facilityWithBoundary
hierarchyType:ADMIN
id:052f59fc-18a7-4e07-816a-f5d8062b56b5 3) userWithBoundary tenantId:mz
type:userWithBoundary
hierarchyType:ADMIN
id:fbfbd393-d053-4f51-9e12-1068b97da292
/project-factory/v1/data/_create
CAMPAIGN_MANAGER
1) type: boundaryWithTarget { "type": "boundaryWithTarget", ""action": "validate",
"campaignId": "13175791-db53-4d10-be90-2dba1c138756" }
2) type: facility { "type": "facility",
"action": "validate",
"campaignId": "13175791-db53-4d10-be90-2dba1c138756"}
3) type: user { "type": "user",
"action": "validate",
"campaignId": "13175791-db53-4d10-be90-2dba1c138756" }
New Features:
A new pop-up has been added which displays the option to download the template in all three upload screens.
Use Case:
when the user comes after clicking next on the delivery screen and the file is not uploaded then this pop-up is displayed.
Was this helpful?