Actions4
Generate Schedule (Wait for Completion)
AI-generatedSummary
Generate a schedule and wait for its completion, returning the final status and optionally a CSV download.
Inputs
- locations (required) — Array of location objects, each containing ID, name, tier (A|B|C), territory, latitude, longitude, and optional availability fields.
- month (required) — Target month in YYYY-MM format; working days (Sat‑Wed) are auto‑computed.
- additionalFields — Optional collection of extra parameters such as Visits Completed, Monthly Target, Period Target, and Excluded Days.
- pollIntervalSec — Interval in seconds between polls while waiting for the schedule to finish.
- maxWaitSec — Maximum time in seconds to wait before timing out; defaults to 600.
- downloadCsv — Whether to download the generated CSV as a binary attachment upon completion.
- binaryPropertyName — Name of the field that will hold the binary CSV data when downloadCsv is true.
Output shape
a single item containing the final schedule status and optionally a binary CSV under the specified field
binary field added only if downloadCsv is true; may include an error if timeout exceeds maxWaitSec
Examples
Example 1: Generate schedule for June 2026, wait for completion, and download CSV
locations=[{…}], month=2026-06, downloadCsv=true, binaryPropertyName=data
Example 2: Generate schedule without CSV download
locations=[{…}], month=2026-07, downloadCsv=false
Example 3: Generate schedule with custom poll and wait settings
locations=[{…}], month=2026-08, pollIntervalSec=10, maxWaitSec=1200