Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Overview
In the Campaign Details stepper, there are 2 screens:
Campaign Type
Campaign Name
This is the first screen when the user clicks on the set-up campaign. In this screen, a user can select the campaign type and the beneficiary will be prepopulated from the MDMS. It is a mandatory field to set up a campaign.
Here, the dropdown will show the list of campaign types that are present in the MDMS. We will fetch the MDMS data from:
MDMS: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/project-types.json
This screen comes after the campaign type. This step is crucial for saving your campaign as a draft, as the name serves as a unique identifier. After clicking on 'Next', the name will be saved and the user can check from the draft.
This screen asks a user to fill in the start and end date of the campaign.
| End Point | Method | Payload |
|---|---|---|
project-factory/v1/project-type/create
POST
{ "hierarchyType": "ADMIN", "tenantId": "mz", "action": "draft", "campaignName": "test90", "resources": [], "projectType": "MR-DN", "additionalDetails": { "beneficiaryType": "INDIVIDUAL", "key": 2 } }
project-factory/v1/project-type/search
POST
{ "tenantId": "mz", "ids": [ "2a2491a7-c52d-4305-8b5b-9aa10ae44168" ], "pagination": {} }
/project-factory/v1/project-type/search
POST
{ "tenantId": "mz", "ids": [ "2a2491a7-c52d-4305-8b5b-9aa10ae44168" ], "pagination": {} }
/project-factory/v1/project-type/update
POST
{ "id": "2a2491a7-c52d-4305-8b5b-9aa10ae44168", "tenantId": "mz", "status": "drafted", "action": "draft", "campaignNumber": "CMP-2024-05-15-000496", "campaignName": "test90", "projectType": "MR-DN", "hierarchyType": "ADMIN", "boundaryCode": "", "projectId": null, "startDate": 1715970599000, "endDate": 1717180199000, "additionalDetails": { "beneficiaryType": "INDIVIDUAL", "key": 3 }, "resources": [], "boundaries": [], "deliveryRules": [], "auditDetails": { "createdBy": "21fed2bc-6a73-41b2-b9ae-0996f5b5ede5", "lastModifiedBy": "21fed2bc-6a73-41b2-b9ae-0996f5b5ede5", "createdTime": 1715762971435, "lastModifiedTime": 1715762971519 } }
This allows users to fill in all the campaign details and create a new campaign.
Click on the following links to learn more:
This screen allows a user to select different boundary details required for the campaign creation. Here, we show the boundary types based on the hierarchy type which is present in the MDMS, MDMS file path :
If we want to fetch the hierarchy type from the MDMS, use the following API:
To fetch the hierarchy definition, this is mentioned in the setUpCampaign page:
After calling the hierarchy, the response is stored in the session storage under the name:
After it is stored, we can use it in the "Selecting Boundaries" component to show the different boundary types present: The FilePath for it is the following: The boundary type in the screen is shown upto the lowest hierarchy level which is also configured from the MDMS. The options in the hierarchy is shown using the following:
In the selection boundary screen, we show options according to parent boundary type using the above API. Some validations for this screen:
All the boundary types in the screen are mandatory.
Lower level boundary type is mandatory if a user has selected the above levels
We have impemented Parallel API calls have been implemented for boundary data search to optimise the performance better. We have added all the API search from the loop and calling parallel calls at once and storing the respective data in respective boundaryType.
For the next time when we are making boundary search api calls, we are checking locally whether data is present otherwise calling the API search only for the required data to optimise it better.
All the above mentioned logic have been added in useParallelSearch.js hook.
Below are the configurations needed for successfully setting up the campaign module:
citymodule needed to run campaign module in an environment:
Link:
roleactions config needed for the user for all campaign access
Link:
actionTest config needed for sidebar action and user access for services
LINK:
To enable action in the sidebar, add navigationUrl and path to the object
Refer to the below id's link in QA:
roles need to be added in roles
Boundary Schema config needs to be added for boundary sheet validation:
Facility Schema config needs to be added for facility sheet validation:
User schema config needs to be added for user sheet validation:
Hierarchy config needs to be added to define lowset hierarchy in boundary selection:
Global configuratio needs to be added to environments.
Helm chart needs to be added in devops.
After the boundaries are selected, the Generate API is called with a delay of 3 seconds when the user clicks on next, using the following hook:
Link:
| EndPoint | Method | Payload |
|---|
Link:
Link:
Link:
Link:
Link:
Link:
Link:
Refer to learn more about the setup environment.
| Module | Use |
|---|
boundary-service/boundary-relationships/_search | POST | Params tenantId=mz hierarchyType=ADMIN boundaryType=Provincia parent=ADMIN_MO |
/boundary-service/boundary-hierarchy-definition/_search | POST | { "tenantId": "mz", "limit": 2, "offset": 0, "hierarchyType": "ADMIN" } |
rainmaker-common | For all common screen localisation messages like login, homepage, sidebar |
rainmaker-campaignmanager | For all admin console related screens localisation messages |
rainmaker-hcm-admin-schemas | For all upload schemas like target, facility, user |
boundary-${BOUNDARY_HIERARCHY_TYPE} | For boundary type localisations, we are getting this BOUNDARY_HIERARCHY_TYPE from the mdms |
Here are the articles in this section:
The logic for the step-by-step screens, stepper functionality, storing data in localStorage, creating/updating campaigns, and restructuring API data back into localStorage is all managed within SetupCampaign.js.
All screens are present in the given configuration. Link: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/configs/CampaignConfig.js
In the configuration:
stepCount represents the step number. Multiple configuration objects can share the same stepCount.
skipAPICall: If this is set to true, the API call for the screen is skipped.
sessionData: Local storage data is passed in custom props, allowing for custom logic to be added to the screens as needed.
In setup campaign, we have functions to perform specific logic.
loopAndReturn: This function takes the delivery rule conditions coming from API response and restructure the data in local storage format.
cycleDataRemap: This function takes the delivery rules data coming from API response and return array of object of start date and end date based on cycles.
reverseDeliveryRemap: This function take the deliveryConditions from API response and return the structure of delivery data.
groupByTypeRemap: This function create the local structure of boundaries.
updateUrlParams: This function is using to update the url.
In a new campaign, we update the total form when a user clicks on next after entering the data.
After updating the total form data, we store the data in localStorage.
We also call the API to draft the data in case a user wants to come back and resume the campaign.
Refer to the following link:
When a user clicks on the draft campaign, he/she can fetch campaign data from the response.
After getting a response, one can restructure the data in screen format and store in the local storage.
After updating, the user is redirected to the last screen where additional details are stored in response.
Refer to the following link:
Based on screens, a user can filter the configuration and show the the stepper based on the configuration.
Refer to the following link:
In the 'Delivery Details' step, users encounter 3 screens:
Delivery Dates
Cycle Configuration
Delivery
This screen asks a user to fill in the start and end date of the campaign.
On this screen, users specify the number of cycles and deliveries. The number of cycles must be at least 1 and can be up to 5. Once the user has defined the number of cycles and deliveries, they can proceed to enter the start and end dates for each cycle.
The number of cycles and deliveries are configurable based on project type. We can configure it in MDMS:
If data is configured, a user will see the number of cycles and deliveries as per the configuration. A user, however, can increase or decrease if they find it necessary.
The validations added for the start date and the end date of the cycles should not overlap to each other.
After filling in all the cycle details, a user can click on 'Next' and move to the Delivery rules screen. Clicking on 'Next' enables a user to store the cycle data in the local storage.
On this screen, users fill in all the delivery details (adding delivery rules, adding conditions in delivery rules, adding products in the delivery rules) of each cycle and delivery which the user has selected in the cycle details screen.
The delivery screen can also be configured based on project type. A user can configure the number of delivery conditions, their attributes, and products. If the data is configured correctly, a user can see the data preloaded in delivery rules and the user can change, remove, or add, if they find it necessary.
A user can add delivery rules up to 5. A user can add conditions in each delivery rule with attribute options having height, weight, gender, and age. For Project type, LLIN-mz configuration is passed in delivery rules in which two fixed attributes are present for the bednet campaign.
After filling in all the delivery rules details, when a user clicks on next, the data will be stored in the localStorage as well as in the draft API. The delivery rules data will be validated in the preview screen.
Reference files:
Delivery rule's screen file path: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/pages/employee/deliveryRule/index.js
API call file path: https://github.com/egovernments/DIGIT-Frontend/blob/campaign/micro-ui/web/micro-ui-internals/packages/modules/campaign-manager/src/pages/employee/SetupCampaign.js
If you click on configure resources on the delivery screen, a pop-up appears where a user can either select or create a product:
Product Screen: When a user clicks on "Add Products to be delivered", a pop-up screen will appear with a list of product variants where a user can add the products and the number of counts in the delivery rules.
A user can add multiple products to the product screen after clicking on "add more resources" When the user clicks on confirm resources, products will be added to the delivery rules. The user can remove the products as well.
If the product is not present, a user can click on "Add New Product" to create a new product and variant, and subsequently add delivery rules. Clicking on "Add New Product" will open the create product screen.
Users can enter product names, product variants, and product types which are sourced from MDMS data. Additionally, a user can create multiple products using the "Add Products" button. After clicking on 'Confirm,' the product will be created, followed by the creation of product variants.
After successful creation, users will be directed to a success response screen.
Here you can find the config of delivery based on project type.
The following is the structure of the delivery configuration:
projectType: This will be the type of the project. If the selected project type is present in the MDMS, then we use that config.
attrAddDisable: if this is true, we are restricting a user that they cannot add any attribute.
deliveryAddDisable: if this is true, a user cannot add any further delivery rule conditions.
cycleConfig: This will be an object containing cycles and deliveries. This refers to the number of cycles and deliveries that will be shown in the cycle screen.
deliveryConfig: This will be an array of objects, each object representing one delivery condition.
Adding product config is a careful job, adding the wrong product in the config will cause issues while creating a product.
In Value, the product variant ID should be added in the value which will be getting in the below API:product/variant/v1/_search
The name will consist of the name of the product and the variant of the product separated with "-"
for name: product/v1/_search
for variant: product/variant/v1/_search
FilePath:
MDMS:
Bednet config: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/hcm-admin-console/deliveryConfig.json
Product Type: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/hcm-admin-console/productType.json
HOOKS:
We have added Delivery type at each delivery conditions showing the delivery type of the campaign.
It is configurable in mdms for the SMC project type. We can add default delivery type at each conditions.
deliveryConfig: It will contain default data of all deliveries.
conditionConfig: It will contain default data of each delivery condition of each deliveries
deliveryType: Default value of delivery type.
A info card is been added in both the screens in the delivery details. Which states the criteria of delivery as recommended by WHO.
The resource upload details consists of 3 types of uploads:
Upload Target Data
Facility Upload
User Upload
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.
This screen will come after the target upload screen.
In this screen, when a user clicks on the download template, an Excel get downloaded that contains 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.
This screen will appear after the facility Details screen.
When a user clicks on the download template, an Excel gets downloaded that consists of with readMe, User Sheet and BoundaryData. The user has to fill 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:
Next, /project-factory/v1/data/_download is used to download the template.
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-
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 sheet names in all the 3 uploads.
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:
Before calling we are using base time out which is fetched from the MDMS
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
A new popup has been added which display the option to download the template in all the 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.
The Summary screen provides users with a comprehensive view of all campaign details entered.
Users can review the entirety of their campaign information. If the campaign status is marked as 'drafted,' users can either edit the existing data or submit it. After submission, the campaign is created, initiating the 'create' action.
For campaigns in a 'draft' status, the summary screen serves as the final step of the campaign setup process, giving users the option to edit or submit the details before finalisation.
If the campaign is successfully created while in the 'draft' status, users are directed to a success screen.
After the API call, the data undergoes restructuring to present delivery rules based on the cycle and delivery details.
If campaign data is incomplete and user tries to create a campaign, then we are showing all the erros in the respective card specifyig the error to the user. User can make the change by using errors button or clicking on edit button showing in the card.
Errors card Implementation:
We are adding all the errors as per screen name in an array and passing the erros as a props in ViewComposer component.
For draft status only:
My campaign screen allows users to see the list of campaigns that are in Ongoing, Completed, or Draft status. Users can search campaign by using the campaign name or campaign type. Users can also see a summary of the campaign and complete the campaign creation if it is draft status.
The list of statuses showing in "My Campaign" screen are:
Ongoing
Completed
Drafts
Failed
Upcoming
After clicking on the My Campaign link from the HCM Campaign module card, the user lands on the My Campaign screens where the user can see all the lists of campaigns of each action in the tab.
On my campaign screen, we are sending the payload:
Campaigns with an end date that has passed the current date are marked as 'Completed'.
Campaigns with a status of 'Started' and no end date, or with an end date in the future, are labeled as 'Ongoing'."
The logic is written in UICustomizations.js
Clicking on campaigns other than draft status will redirect to the summary page of the campaign where the user can see the complete details of the respective campaign.
For the ongoing campaign filtering functionality, we are utilizing the campaignsIncludeDates parameter set to true. The startDate and endDate parameters are both set to the current date. This configuration ensures that the API will return any campaign where the specified startDate or endDate falls within the campaign's defined start and end dates. Additionally, the campaign status is filtered to include campaigns with statuses of created or creating.
campaignsIncludeDates: This boolean parameter is set to true to enable date range filtering.
startDate: The start date for the filter, set to today's date.
endDate: The end date for the filter, also set to today's date.
status: The campaign status filter, including the statuses created and creating.
To filter the ongoing campaigns based on the criteria mentioned above, ensure that your request payload includes the following parameters:
campaignsIncludeDates = true: This activates the date range filtering feature.
startDate and endDate = today: By setting both the start and end dates to today's date, the filter will capture any campaigns that are active today.
status = ["created", "creating"]: Filters the campaigns to only include those that are currently in the created or creating status.
For filtering completed campaigns, we use a similar approach with a slight modification to the date parameters and status. Specifically, we will set the endDate parameter to yesterday's date. This configuration ensures that the API returns campaigns that have ended as of yesterday. The statuses to filter will remain creating and created.
endDate: The end date for the filter, is set to yesterday's date.
status: The campaign status filter, including the statuses creating and created.
To filter the ongoing campaigns based on the criteria mentioned above, ensure that your request payload includes the following parameters:
endDate = yesterday: By setting the end date to yesterday's date, the filter will capture any campaigns that have ended by the end of the previous day.
status = ["created", "creating"]: Filters the campaigns to include only those that were in the created or creating status when they ended.
When a user clicks on completed campaign, they will be redirected to the summary page displaying the campaign details. The success toast message will appear If user credential sheet is generated successfully. User can view or download the sheet from the user credential card or download button which appears at the top.
For filtering upcoming campaigns, we use a different approach by setting the campaignsIncludeDates parameter to false and specifying the startDate parameter to tomorrow's date in epoch format. This configuration ensures that the API returns campaigns scheduled to start tomorrow. The statuses to filter will remain creating and created.
campaignsIncludeDates: This boolean parameter is set to false as we are not filtering based on a date range but rather a specific start date.
startDate: The start date for the filter, set to tomorrow's date in epoch format.
status: The campaign status filter, including the statuses creating and created.
To filter the upcoming campaigns based on the criteria mentioned above, ensure that your request payload includes the following parameters:
campaignsIncludeDates = false: This deactivates the date range filtering feature, focusing the filter on a specific start date.
startDate = tomorrow (epoch date): By setting the start date to tomorrow's date in epoch format, the filter will capture any campaigns scheduled to start tomorrow.
status = ["created", "creating"]: Filters the campaigns to include only those that are in the created or creating status and scheduled to start tomorrow.
When a user clicks on upcoming campaign, they will be redirected to the summary page displaying the campaign details.
For the drafts campaign, we are passing the status as drafted. It will return all the drafts which are in drafted status
For failed campaigns, we are passing the status as failed. It will return all the drafts which are in failed status
When a user clicks on a failed campaign, they will be redirected to the summary page displaying the campaign details. Additionally, a toast message will appear, showing the error that caused the campaign to fail.
Path: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/project-types.json
This screen enables users to update the start date, end date, and cycle dates for both ongoing and upcoming campaigns. Additionally, an 'Actions' column has been added to the "My Campaign" screen, providing more options for managing the campaigns.
When a user clicks on 'Actions', they will see the "Update Dates" option. Selecting "Update Dates" redirects the user to the update date screen.
We have added an MDMS configuration flag to determine whether the dates can be updated with or without boundaries. Depending on the MDMS flag, the appropriate screen will be rendered.
If the MDMS flag for updating dates with a boundary is set to true, the corresponding screen for updating dates will be rendered.
If the MDMS flag for updating with a boundary is set to true, the corresponding screen will be rendered. On this screen, the user first selects the hierarchy level and boundary they wish to update. After making their selection, the user clicks the 'Confirm' button.
Based on the selected boundaries, the corresponding dates are displayed. The user can then change the dates and cycle dates as needed. Fields with dates that have already passed (relative to today) are made non-editable.
After making the desired changes, the user clicks the 'Confirm' button to update the dates. Once the update is successful, a success response screen is shown, and the user is redirected back to the "My Campaign" screen.
If the MDMS flag is set to false, the corresponding screen is rendered to update the dates without considering boundaries, at the root level.
When the user clicks on "Update Date" for the respective campaign, the update date screen is shown with all the prefilled start and end dates. The user can then make the necessary changes.
The user can change the editable dates. Any date fields that have passed the current date are non-editable. Once the user confirms the date change, the data is updated. After a successful update, the user is redirected to a success screen.
MDMS configuration to check whether the update date is at the root level or boundary level: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-DEV/data/mz/health/hcm-admin-console/dateWithBoundary.json
MDMS Link:
This screen allows the user to create a new hierarchy and then upload the boundary data in bulk.
Upload Boundary Screen
This screen allows the user to select the hierarchy. According to that, a template is downloaded in which the user needs to fill in the boundary data. If the hierarchy type is not present, then the user can make a new hierarchy using this screen.
Create Boundary Hierarchy
The user needs to give a hierarchy name, and levels according to the hierarchy.
UI Validation: Headers should be according to the template downloaded.
API Details
The timeline provides a visual representation of the campaign creation process. It can be accessed from the summary or through the action button on the "My Campaign" screen. The timeline will be shown for ongoing, upcoming, completed, and failed campaigns.
This timeline shows all the stages of the campaign that are successfully created. A user can download the user credentials as soon as the campaign is created successfully.
The above images show all three timeline steps: upcoming, current, and completed.
A user can also access the timeline from the "My Campaign" screen by clicking on the action button present in the search result.
The timeline will be shown in the form of a pop-up from the "My Campaign" screen. Similar to the summary, while the campaign creation is in progress, it will display all the steps such as upcoming, current, and completed. User credentials will be downloaded once the campaign is successfully created.
A new "Actions" column has been added to the "My Campaign" screen, allowing users to perform some task in a handy way.
Users can click on "Actions" to choose from the available action options in the menu.
We've added config for column actions in myCampaignConfig.js
In UICustomization.js, We've added component which needs to be render for the action column under additionalCustomizations.
We have added onActionSelect function which perform action based on selected option.
File Path:
Config:
UICustomisation:
| End Point | Method | Payload |
|---|---|---|
| End Point | Method | Payload |
|---|---|---|
| End point | Method | Payload |
|---|---|---|
| End Point | Method | Payload |
|---|---|---|
| End Point | Method | Payload |
|---|---|---|
| EndPoint | MDMS Roles | Method | Payload |
|---|
| End point | Method | Params |
|---|
product/variant/v1/_search
POST
{ "ProductVariant": {}, "RequestInfo": { } }
product/v1/_search
POST
{ "Product": { "id": [ "P-2024-01-04-000094", "P-2024-01-04-000094", "P-2024-01-04-000095", "P-2024-01-04-000095", "P-2024-01-04-000096", "P-2024-01-04-000094", "P-2024-01-04-000094", "P-2024-01-04-000095", "P-2024-01-04-000095",] }, "RequestInfo": { } }
product/v1/_create
POST
{ "Product": [ { "tenantId": "mz", "type": "BEDNET", "name": "CHECKTHEONE" } ], "apiOperation": "CREATE", "RequestInfo": { } }
product/variant/v1/_create
POST
{ "ProductVariant": [ { "tenantId": "mz", "productId": "P-2024-05-09-000322", "variation": "1000" } ], "apiOperation": "CREATE", "RequestInfo": { } }
project-factory/v1/project-type/update
POST
{ "CampaignDetails": { "id": "76e7f371-1f85-4739-97dc-feb4ee10fa6b", "tenantId": "mz", "status": "drafted", "action": "draft", "campaignNumber": "CMP-2024-05-09-001413", "campaignName": "TheNewOne", "projectType": "LLIN-mz", "hierarchyType": "ADMIN", "boundaryCode": "", "projectId": null, "startDate": 1716056999000, "endDate": 1716488999000, "additionalDetails": { "beneficiaryType": "HOUSEHOLD", "key": 5 }, "resources": [], "boundaries": [], "deliveryRules": [ { "cycleNumber": 1, "deliveryNumber": 1, "deliveryRuleNumber": 1, "products": [ { "value": "PVAR-2024-01-24-000076", "name": "SP - 500mg", "count": 1 } ], "conditions": [ { "attribute": "CAMPAIGN_BEDNET_INDIVIDUAL_LABEL", "operator": null, "value": null }, { "attribute": "CAMPAIGN_BEDNET_HOUSEHOLD_LABEL", "operator": null, "value": null } ] } ], "auditDetails": { "createdBy": "63a21269-d40d-4c26-878f-4f4486b1f44b", "lastModifiedBy": "63a21269-d40d-4c26-878f-4f4486b1f44b", "createdTime": 1715270852152, "lastModifiedTime": 1715273123616 } }, "RequestInfo": { } }
/project-factory/v1/data/_generate
POST
Params will be different for different types- 1) facilityWithBoundary
tenantId:mz
type:facilityWithBoundary
forceUpdate:true
hierarchyType:ADMIN
campaignId:13175791-db53-4d10-be90-2dba1c138756 2) boundary tenantId:mz
type:boundary
forceUpdate:true
hierarchyType:ADMIN
campaignId:13175791-db53-4d10-be90-2dba1c138756 3)userWithBoundary tenantId:mz
type:userWithBoundary
forceUpdate:true
hierarchyType:ADMIN
campaignId:13175791-db53-4d10-be90-2dba1c138756
/project-factory/v1/data/_download
POST
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
POST
1) type: boundaryWithTarget { "type": "boundaryWithTarget", "hierarchyType": "ADMIN", "tenantId": "mz", "fileStoreId": "ad9efbdb-b2c5-434e-b86e-1cb02d61e758", "action": "validate", "campaignId": "13175791-db53-4d10-be90-2dba1c138756", "additionalDetails": {} } 2) type: facility { "type": "facility", "hierarchyType": "ADMIN", "tenantId": "mz", "fileStoreId": "a5ca723c-e463-4428-86b4-e0f706973857", "action": "validate", "campaignId": "13175791-db53-4d10-be90-2dba1c138756", "additionalDetails": {} } 3) type: user { "type": "user", "hierarchyType": "ADMIN", "tenantId": "mz", "fileStoreId": "3f6348b0-7e10-4f1a-8f48-dcfb0c9afdff", "action": "validate", "campaignId": "13175791-db53-4d10-be90-2dba1c138756", "additionalDetails": {} }
/project-factory/v1/project-type/update
POST
{ "CampaignDetails": { "id": "eacb77b9-0bcd-4939-88a6-ca9456eb7bc4", "tenantId": "mz", "status": "drafted", "action": "create", "campaignNumber": "CMP-2024-05-09-001425", "campaignName": "checkte", "projectType": "LLIN-Moz", "hierarchyType": "ADMIN", "boundaryCode": "mz", "projectId": null, "startDate": 1715538599000, "endDate": 1717266599000, "additionalDetails": { "beneficiaryType": "HOUSEHOLD", "key": 10 }, "resources": [ { "type": "facility", "filename": "fac.xlsx", "filestoreId": "19be64bc-5a03-4932-9b88-90feb16e642a" }, { "type": "boundaryWithTarget", "filename": "TR.xlsx", "filestoreId": "8821993e-339b-4af5-9263-337276891065" } ], "boundaries": [ { "code": "mz", "type": "Country", "isRoot": true, "includeAllChildren": true }], "deliveryRules": [ { "startDate": 1715711399000, "endDate": 1716661799000, "cycleNumber": 1, "deliveryNumber": 1, "deliveryRuleNumber": 1, "products": [ { "value": "PVAR-2024-01-24-000076", "name": "SP - 500mg", "count": 1 } ], "conditions": [ { "attribute": "Age", "operator": "LESS_THAN", "value": 100 } ] } ], "auditDetails": { "createdBy": "63a21269-d40d-4c26-878f-4f4486b1f44b", "lastModifiedBy": "63a21269-d40d-4c26-878f-4f4486b1f44b", "createdTime": 1715275958664, "lastModifiedTime": 1715276207117 } }, "RequestInfo": { } }
/project-factory/v1/project-type/search
POST
{ "RequestInfo": { }, "CampaignDetails": { "tenantId": "mz", "status": [ "failed" ], "createdBy": "ff98f9f6-192b-4e12-8e90-7b73dcd0ad4d", "pagination": { "sortBy": "createdTime", "sortOrder": "desc", "limit": 10, "offset": 0 } } }
/health-project/v1/_search?tenantId=mz&limit=10&offset=0
POST
"Projects": [ { "tenantId": "mz", "id": "c714afc2-9ab8-4d0a-bf2b-71fe56649a77" } ]
/health-project/v1/_update
POST
{ "Projects": [ { "id": "c714afc2-9ab8-4d0a-bf2b-71fe56649a77", "tenantId": "mz", "projectNumber": "PJT-2024-07-08-001876", "name": "MR_DN_CHECK_TEST_001", "projectType": "MR-DN", "projectSubType": "MR-DN", "department": "MALARIA", "description": "configuration for Multi Round Campaigns", "referenceID": "b8bb1cd8-99f8-4bf8-82e3-751c06aa70e4", "projectTypeId": "b1107f0c-7a91-4c76-afc2-a279d8a7b76a", "documents": null, "address": { "id": "9e3b5e50-5dde-4f8a-88cb-9b9b1e9c3dab", "tenantId": "mz", "clientReferenceId": null, "doorNo": null, "latitude": 0, "longitude": 0, "locationAccuracy": 0, "type": null, "addressLine1": null, "addressLine2": null, "landmark": null, "city": null, "pincode": null, "buildingName": null, "street": null, "boundaryType": "Country", "boundary": "WORKBENCH_MO", "locality": null }, "startDate": 1721154600000, "endDate": 1725128999000, "isTaskEnabled": false, "parent": null, "projectHierarchy": null, "natureOfWork": null, "ancestors": null, "descendants": null, "targets": [ { "id": "fd1faf99-7980-429c-99c6-4041b854376f", "beneficiaryType": "INDIVIDUAL", "totalNo": 62520, "targetNo": 62520, "isDeleted": false, "auditDetails": { "createdBy": "867ba408-1b82-4746-8274-eb916e625fea", "lastModifiedBy": "867ba408-1b82-4746-8274-eb916e625fea", "createdTime": 1720417261161, "lastModifiedTime": 1721633347090 } } ], "additionalDetails": { "projectType": { "id": "b1107f0c-7a91-4c76-afc2-a279d8a7b76a", "code": "MR-DN", "name": "MR_DN_CHECK_TEST_001", "group": "MALARIA", "cycles": [ { "id": "1", "endDate": 1721586599000, "startDate": 1721241000000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null }, { "id": "2", "endDate": 1722104999000, "startDate": 1721673000000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null }, { "id": "3", "endDate": 1722709799000, "startDate": 1722277800000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null } ], "resources": [ { "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true }, { "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true }, { "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ], "validMaxAge": 59, "validMinAge": 3, "beneficiaryType": "INDIVIDUAL", "observationStrategy": "DOT1" } }, "isDeleted": false, "rowVersion": 0, "auditDetails": { "createdBy": "867ba408-1b82-4746-8274-eb916e625fea", "lastModifiedBy": "867ba408-1b82-4746-8274-eb916e625fea", "createdTime": 1720417261161, "lastModifiedTime": 1721633347090 } } ] }
/health-project/v1/_search?tenantId=mz&limit=10&offset=0
POST
"Projects":[ { "name": "MR_DN_CHECK_TEST_001", "tenantId": "mz", "address": { "boundary": "WORKBENCH_MO_13_NAMPULA" } } ]
/health-project/v1/_update
POST
"Projects": [ { "id": "7b0d31c0-172a-4a6a-a0e9-b5f89ba72415", "tenantId": "mz", "projectNumber": "PJT-2024-07-08-001884", "name": "MR_DN_CHECK_TEST_001", "projectType": "MR-DN", "projectSubType": "MR-DN", "department": "MALARIA", "description": "configuration for Multi Round Campaigns", "referenceID": "b8bb1cd8-99f8-4bf8-82e3-751c06aa70e4", "projectTypeId": "b1107f0c-7a91-4c76-afc2-a279d8a7b76a", "documents": null, "address": { "id": "ca7f66e9-f3b9-4c3b-ac93-293f237ba38b", "tenantId": "mz", "clientReferenceId": null, "doorNo": null, "latitude": 0, "longitude": 0, "locationAccuracy": 0, "type": null, "addressLine1": null, "addressLine2": null, "landmark": null, "city": null, "pincode": null, "buildingName": null, "street": null, "boundaryType": "Province", "boundary": "WORKBENCH_MO_13_NAMPULA", "locality": null }, "startDate": 1721154600000, "endDate": 1725820199000, "isTaskEnabled": false, "parent": "c714afc2-9ab8-4d0a-bf2b-71fe56649a77", "projectHierarchy": "c714afc2-9ab8-4d0a-bf2b-71fe56649a77.7b0d31c0-172a-4a6a-a0e9-b5f89ba72415", "natureOfWork": null, "ancestors": null, "descendants": null, "targets": [ { "id": "9deba653-743d-4b4f-bd0f-57cf04d84666", "beneficiaryType": "INDIVIDUAL", "totalNo": 62520, "targetNo": 62520, "isDeleted": false, "auditDetails": { "createdBy": "867ba408-1b82-4746-8274-eb916e625fea", "lastModifiedBy": "867ba408-1b82-4746-8274-eb916e625fea", "createdTime": 1720417262456, "lastModifiedTime": 1721297458172 } } ], "additionalDetails": { "projectType": { "id": "b1107f0c-7a91-4c76-afc2-a279d8a7b76a", "code": "MR-DN", "name": "MR_DN_CHECK_TEST_001", "group": "MALARIA", "cycles": [ { "id": "1", "endDate": 1721672999000, "startDate": 1721241000000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null }, { "id": "2", "endDate": 1722104999000, "startDate": 1721673000000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null }, { "id": "3", "endDate": 1722709799000, "startDate": 1722277800000, "deliveries": [ { "id": "1", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "DIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "2", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null }, { "id": "3", "doseCriteria": [ { "condition": "3<=ageandage<=11", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] }, { "condition": "12<=ageandage<=59", "ProductVariants": [ { "quantity": 1, "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true } ] } ], "deliveryStrategy": "INDIRECT", "mandatoryWaitSinceLastDeliveryInDays": null } ], "mandatoryWaitSinceLastCycleInDays": null } ], "resources": [ { "productVariantId": "PVAR-2024-02-26-000034", "isBaseUnitVariant": true }, { "productVariantId": "PVAR-2024-03-15-000042", "isBaseUnitVariant": true }, { "productVariantId": "PVAR-2024-03-15-000043", "isBaseUnitVariant": true } ], "validMaxAge": 59, "validMinAge": 3, "beneficiaryType": "INDIVIDUAL", "observationStrategy": "DOT1" } }, "isDeleted": false, "rowVersion": 0, "auditDetails": { "createdBy": "867ba408-1b82-4746-8274-eb916e625fea", "lastModifiedBy": "867ba408-1b82-4746-8274-eb916e625fea", "createdTime": 1720417262456, "lastModifiedTime": 1721297458172 } } ]
boundary-service/boundary-hierarchy-definition/_search
POST
BoundaryTypeHierarchySearchCriteria: { "tenantId": "mz", "limit": 2, "offset": 0, "hierarchyType": "Workbench" }
/boundary-service/boundary-hierarchy-definition/_create | 1759 - CAMPAIGN_MANAGER | POST | { "tenantId": "mz", "hierarchyType": "test", "boundaryHierarchy": [ { "boundaryType": "country", "parentBoundaryType": null, "active": true }, { "boundaryType": "state", "parentBoundaryType": "country", "active": true } ] } |
/project-factory/v1/data/_create | 1772- CAMPAIGN_MANAGER | POST | { "tenantId": "mz", "type": "boundary", "fileStoreId": "1f984e91-2ed2-4d5c-8788-37b3a4c8fcbc", "action": "create", "hierarchyType": "test", "additionalDetails": {} } |
/boundary-service/boundary-hierarchy-definition/_search | 1760-CAMPAIGN_MANAGER | POST | { "tenantId": "mz" } |
/project-factory/v1/project-type/getProcessTrack | POST | params: { campaignId: campaignId, }, |
