> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v1.5/setup/installation/how-to-configure-irs-through-admin-console.md).

# How to configure IRS through admin console

### Overview

After setting up system data, we need to create the campaign, which we can create using workbench user interface

### Setup Localisation

Localisation is required to get started with workbench ui. To setup localisation, follow these steps - [Project Data Setup](/health/v1.5/setup/installation/project-data-setup.md#loading-localisation)

### Update Roles In MDMS Config

* Port forward mdms v2 using below cmd

```
kubectl port-forward svc/mdms-v2 -n egov 8080:8080
```

* Search for admin schema using below curl

```
curl --location 'http://localhost:8080/mdms-v2/v2/_search' --header 'Content-Type: application/json' --data '{  "RequestInfo": {  "apiId": "hcm",  "ver": ".01",  "ts": 1718000364924,  "action": "_search",  "did": "1",  "key": "1",  "authToken": "9cd4a306-8bed-4e91-9306-2a2250cec891"  },  "MdmsCriteria": {  "tenantId": "mz",  "isActive": true,  "schemaCode": "HCM-ADMIN-CONSOLE.adminSchema",  "uniqueIdentifiers": [  "user.all"  ]  } }'
```

* In the response, check for `mdms` list and copy the id value from the first object and keep
* import below curl and replace the id in object `Mdms` with above copied value

{% code fullWidth="true" %}

```
curl --location 'http://localhost:8080/mdms-v2/v2/_update/HCM-ADMIN-CONSOLE.adminSchema' --header 'Content-Type: application/json' --data '{  "RequestInfo": {  "apiId": "hcm",  "ver": ".01",  "ts": 1718000364924,  "action": "_search",  "did": "1",  "key": "1",  "authToken": "9cd4a306-8bed-4e91-9306-2a2250cec891",  "userInfo": {  "uuid": "1f1bfedb-b86d-4319-9370-5c5d95b1e93f"  }  },  "Mdms": {  "id": "2005d578-6274-47da-a88e-93044c2e2320",  "tenantId": "mz",  "schemaCode": "HCM-ADMIN-CONSOLE.adminSchema",  "uniqueIdentifier": "user.all",  "data": {  "title": "user",  "$schema": "http://json-schema.org/draft-07/schema#",  "properties": {  "enumProperties": [  {  "enum": [  "Registrar",  "Distributor",  "Supervisor",  "National Supervisor",  "Provincial Supervisor",  "District Supervisor",  "Team Supervisor",  "Helpdesk User",  "Monitor Local",  "Logistical Officer",  "Health Facility Worker",  "Warehouse Manager"  ],  "name": "HCM_ADMIN_CONSOLE_USER_ROLE",  "isRequired": true,  "description": "User Role",  "orderNumber": 3  },  {  "enum": [  "Temporary",  "Permanent"  ],  "name": "HCM_ADMIN_CONSOLE_USER_EMPLOYMENT_TYPE",  "isRequired": true,  "description": "Employement Type",  "orderNumber": 4  }  ],  "numberProperties": [  {  "name": "HCM_ADMIN_CONSOLE_USER_PHONE_NUMBER",  "type": "number",  "maximum": 9999999999,  "minimum": 1000000000,  "isUnique": true,  "isRequired": true,  "description": "Phone Number",  "orderNumber": 2,  "errorMessage": "HCM_ADMIN_CONSOLE_USER_PHONE_NUMBER_ERROR"  }  ],  "stringProperties": [  {  "name": "HCM_ADMIN_CONSOLE_USER_NAME",  "type": "string",  "maxLength": 128,  "minLength": 2,  "isRequired": true,  "description": "User Name",  "orderNumber": 1  },  {  "name": "HCM_ADMIN_CONSOLE_BOUNDARY_CODE_MANDATORY",  "type": "string",  "isRequired": true,  "description": "Boundary Code (Mandatory)",  "orderNumber": 5,  "errorMessage": "HCM_ADMIN_CONSOLE_BOUNDARY_CODE_MANDATORY_ERROR"  }  ]  },  "campaignType": "all"  },  "isActive": true,  "auditDetails": {  "createdBy": "a1fc1a17-f324-479f-bd2a-f2e9b9d0fd83",  "lastModifiedBy": "13f801d0-03da-4fe7-8299-250f5396e2bc",  "createdTime": 1717754171827,  "lastModifiedTime": 1718781116871  }  } }'
```

{% endcode %}

* Send the request to update

### Setup Campaign Steps

1. Open Workbench UI - `https://<domain_name>/workbench-ui/employee/user/language-selection` , Select a Language and Login with Superuser `username` and `password` , Then click on `Setup-campaign`&#x20;
2. Select type of campaign as `IRS-mz` and click next
3. Give `Name of the campaign` as `IRS` and click next
4. Select the boundaries where you want to run the campaign and click next
5. Select the start and end date of the campaign and click next. \*Note that deliveries would work only from start date, not before this.
6. Select start and end dates for cycles as campaign start date and end date and click next.
7. Configure conditions for delivery step -
   1. Click on `Add Resources to be delivered` button
   2. Click on `Add New Resource`&#x20;
   3. Use Resource type as `Spray` and resource variant as `50ml` and create resources for names `Sumishield`, `Fludora`, `Delt`, `Acetellic`, `DOT` and `Bendiocarb` one by one.
   4. After all the resources are created. Click on `Add Resources to be delivered` and add all the resources.
   5. Click on Add more delivery conditions and select reeds, clay respectively and select all resources as step 4 then click next
8. Download the Target template and update overall targets for villages and rooms in columns `Household Target at a village level`,  `Room Target at a village level`  ie 100, 300 for each row. And go back to workbench ui and select updated target file to upload and click next.
9. Download the template for facility data and add one or more facilities using below steps. Then upload the saved file in workbench ui and click next.
   1. Select Facility Type as Warehouse
   2. Facility Status as Permanent
   3. Capacity as 1000000
   4. &#x20;Boundary Code (check in sheet Boundary Data in downloaded template and choose any)
   5. Facility Usage as Active
10. Download the template for user details. In this downloaded template add users with role Distributor, National Supervisor, Provincial Supervisor, District Supervisor, Team Supervisor and a Warehouse Manager and fill up other details. Then upload the saved file back in workbench ui and click next.
11. This step shows overview of all the steps data. Edit any step if required otherwise click on create campaign.

<div><figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2F3Hu1DpWyrngm2YmO2Lip%2FScreenshot%20from%202024-10-01%2015-42-09.png?alt=media&amp;token=ab34d5a1-0541-4711-829c-1b6505728c65" alt=""><figcaption></figcaption></figure> <figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2FeLwcVXQm7wlr3C3fTDrd%2FScreenshot%20from%202024-10-01%2015-42-19.png?alt=media&amp;token=10d33f16-ad89-4796-b62c-b81966c01d8d" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2Fc6qDTaHYWENZR2FH8NeC%2FScreenshot%20from%202024-10-01%2015-50-29.png?alt=media&amp;token=476a7968-9f76-451d-bd43-3cf8e9ff70ff" alt="" width="375"><figcaption></figcaption></figure> <figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2FYxJnQsJDXEiv43MTXd7F%2FScreenshot%20from%202024-10-01%2015-53-14.png?alt=media&amp;token=589f4259-be3d-4565-a52f-3886698aebb0" alt="" width="375"><figcaption></figcaption></figure></div>

<div><figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2FMzPSTtjRQeCe09KYda6a%2FScreenshot%20from%202024-10-01%2015-54-53.png?alt=media&amp;token=57e0f9f9-8ae4-4da0-8850-16b9f93c39e7" alt=""><figcaption></figcaption></figure> <figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2F0mbOr47IaZTU5D6HmPVs%2FScreenshot%20from%202024-10-01%2015-59-37.png?alt=media&amp;token=c2e50bf1-a325-48c7-b1b0-df09e245cdd0" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2Fb8lOWDUobMY7FxkzH4bx%2FScreenshot%20from%202024-10-01%2016-07-15.png?alt=media&amp;token=86b6fb5d-f06f-4f0c-877a-7c0153977af2" alt=""><figcaption></figcaption></figure> <figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2Fepyd0q96yxJV5cl3JPiS%2FScreenshot%20from%202024-10-01%2016-11-22.png?alt=media&amp;token=e2ddc575-9328-4ad8-a0e4-82c9d33983b7" alt=""><figcaption></figcaption></figure> <figure><img src="https://3371302308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGYQEda2SOh4goA6Ee2d2%2Fuploads%2FMhSNPZcCjYxKaxtL9xLd%2FScreenshot%20from%202024-10-01%2016-20-31.png?alt=media&amp;token=a44887ef-67f7-4230-8ee5-255d0c0623c2" alt=""><figcaption></figcaption></figure></div>

### After Campaign Creation Steps

On successful creation wait for 5 minutes for internal processes to complete, then go to the home page and select `My Campaign`&#x20;

1. Select the `Upcoming` tab and select the created campaign.
2. Check for the timeline and progress of creation of the campaign data. If it shows `Campaign successfully created` , check for the download button for user credentials and download credentials.
3. Share the credentials with users and start using mobile apk from project start date.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/health/v1.5/setup/installation/how-to-configure-irs-through-admin-console.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
