Campaign Setup

When you click Create Campaign, you will land on the campaign home screen. Here you have two options:

1. Create New Campaign

2. Import Existing Campaign (not available in this version).

Creating a New Campaign

Step 1: Select Campaign Type

• Click Create New Campaign.

• A pop-up will show the items needed to create a campaign. Click Continue.

• Choose the campaign type from a dropdown (options come from MDMS: HCM-PROJECT-TYPES.projectTypes).

• This is a mandatory step.

Step 2: Enter Campaign Name

• Enter a name for the campaign.

• A default name will be suggested based on the campaign type, current month, and year. You can edit this if needed.

• Validation: The campaign name must be unique.

• Validation API: /project-factory/v1/project-type/search

Step 3: Set Campaign Dates

• Enter start and end dates for the campaign.

• Validation:

  • Dates cannot be earlier than today.

  • End date must be later than start date.

• API Used: /project-factory/v1/project-type/create

After submitting, you will be redirected to the campaign details screen. You can continue creating the campaign or save it as a draft under My Campaigns and resume later.

• You can edit the campaign name and dates anytime using the edit icons.

Tasks to Complete Campaign Setup

1. Define Target Areas

   • Select the boundaries where the campaign will run.

   • Validation: Must select down to the lowest level boundary. If a parent boundary is chosen, at least one child must also be selected.

   
2. Configure Delivery

   • Define campaign cycles, number of deliveries, and their dates.

   • Set delivery conditions and allocate resources for each cycle.

   

   
3. Configure Mobile App This sets up the app that field workers will use.

   • Module Selection

     • Choose modules to include in the app (from MDMS: HCM-ADMIN-CONSOLE.FormConfigTemplate).

     • Selected modules are saved under HCM-ADMIN-CONSOLE.AppConfigSchema.

     • Localisation modules are auto-created for the campaign.

     
   • Feature Selection

     • Select features for each module.

     • Features are fetched from HCM-ADMIN-CONSOLE.AppModuleSchema.

     • Display depends on what’s marked as selected in the AppConfigSchema.

     
   • App Configuration

     • Configure how features will appear in the app.

     
4. Upload Data

   • Upload sheets for facilities, users, and targets.

5. Checklist (Optional)

   • Create checklists if needed.

Once all tasks are done, click Create Campaign. The campaign will appear under Upcoming Campaigns in My Campaigns.

My Campaign Page

Accessible from the home screen. Shows the status of your campaigns.

Each campaign card provides actions:

• Clone Campaign – Create a copy of an existing campaign. You just need to enter a new name and start/end dates.

• Download Mobile App – Opens a QR code pop-up to download the app.

• Download User Credentials – Downloads an Excel with user credentials and passwords.

• Edit Campaign – Update boundaries or delivery dates.