Schedule Visits
schedule_visitsSchedules recurring visits: expands each account's cadence (e.g. every 7 days, twice a month) across a horizon and packs the visits into daily work clusters (buckets) under a technician-day cap. Decides which day each visit happens (auto_build and cluster_points divide accounts among people instead); creates no alignment. Needs point_layer (ingested, with the cadence column declared, else UNDECLARED_FIELD), visit_frequency_field, dwell_time, and daily_capacity (e.g. {mode: not_to_exceed, hours: 8}); missing dwell or capacity returns CLARIFICATION_REQUIRED with the question. Optional contractors (point_layer or list with start, pre_service_stops, route_type, end) anchors each bucket to a contractor and includes stem travel. frequency_unit: interval_days or visits_per_horizon. never_visit_values are excluded. bucket_workload_hours is bucket drive plus dwell, a different measure from territory workload and route_workload_hours. Returns a task. calculate_route over one bucket_id drives that day. Date limits use visit_constraints with horizon_start_date.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ts | No | ||
| horizon | No | ||
| objective | No | ||
| ts_handle | No | ||
| dwell_time | No | ||
| contractors | No | ||
| point_layer | Yes | ||
| daily_capacity | No | ||
| frequency_unit | No | interval_days | |
| map_session_id | No | ||
| schedule_label | No | ||
| emit_visit_layer | No | ||
| visit_layer_name | No | ||
| expected_revision | No | ||
| visit_constraints | No | ||
| horizon_start_date | No | ||
| never_visit_values | No | ||
| max_buckets_per_day | No | ||
| visit_frequency_field | Yes | ||
| cadence_flexibility_pct | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||