BeatPlan Upload Guide

Modified on Thu, 19 Sep at 1:39 PM

This guideline outlines the required fields for uploading or modifying BeatPlans using a CSV file.

Upload Fields:

S.N

Field Name

Description

user_br_id

The BR ID for the team member you want to assign to the BeatPlan

plan_start_date

The date from which this plan will start.

plan_end_date

The date on which this plan will end.

route_id

The BR ID of the route for which you want to plan beats. (Ignore this if it's a customer-level BeatPlan.)

customer_br_id

The BR ID of the customer for whom you want to plan beats. (Ignore this if it's a route-level BeatPlan.)

plan_onlyon_date

Fill this field only if the BeatPlan is for a specific date. (If filled, this field will override the `Plan_start_date` and `Plan_end_date` in the upload file.)

days

The days of the week on which this plan will repeat. Use numbers 1 to 7, where 1 represents Monday and 7 represents Sunday. You can use comma (,) to separate multiple values.

week_no

Specifies the weeks of the month this plan will repeat. Use numbers 1 to 5, representing the 1st to 5th weeks of the month. You can use comma (,) to separate multiple values

frequency

Indicates the frequency of the visits. The possible values are:

daily	If you want to schedule daily visits
weekly	Schedule for weekly visits like Monday, Tuesday etc
fortnightly1	visits every other week starting from the 1st week of the month, repeating. in the 3rd & 5th weeks
fortnightly2	visits every alternate week starting from the 2nd week of the month, repeating in the 4th week
monthly	For monthly visits (On specific dates every month)

is_delete

A binary value (1 or 0). Use 1 to delete an existing plan through re-upload, and 0 to retain the plan

Examples:

Weekly Visits on a Route: If you want a certain route to be visited on Monday every week, set
- Days: 1 (Monday)
- Week_no: 1,2,3,4,5
- Frequency: weekly
Visits on Specific Weeks:
- Days: 2 (Tuesday)
- Week_no: 1,3
- Frequency: monthly

Key Points:

Use integer values for BR IDs and binary values for Is_delete.
Use consistent date format "DD-MM-YYYY (like 11-09-2024).
Separate multiple values with commas (e.g., Days, Week_no).
The Plan_onlyon_date field overrides Plan_start_date and Plan_end_date if provided.
Ensure the CSV file adheres to this format to prevent upload errors.

Additional Notes:

For route-level BeatPlans, use route_id.
For customer-level BeatPlans, use customer_br_id.
The fortnightly1 and fortnightly2 options specify different starting weeks for bi-weekly visits.

By following these guidelines, you can effectively upload and manage BeatPlans using CSV files.