States

Every vehicle planning has a state. The default state is bookable. Other possible values are draft, manual, cancelled, and completed. This state is independent of whether a vehicle planning is active.

The state is set when a vehicle planning is created or imported. If the state is omitted on import, the default state bookable is assigned.

The states have the following effects:

• bookable. A bookable task list is considered in matching. This is the default state.
• draft. A task list in state draft isn’t used by the matching core. This is useful when preparing vehicle plannings without the risk that rides are matched into them immediately after creation. For example, pauses may still need to be adjusted before the task list is set to planned.
• manual. A task list in state manual isn’t considered in matching, but booked rides can be moved here manually.
• cancelled. A task list marked cancelled isn’t used in matching. This state reflects that a task list was planned previously but was later canceled, for example because no bookings were made in time.
• completed. As soon as the driver marks the End shift task as completed, the shift is marked as completed automatically. From then on, booking into this shift is no longer possible.

The state cancelled is motivated by an AST use case. If an administrator wants to cancel a vehicle planning — for example because the prebooking period has passed and no one signed up — it can be canceled. Keeping the unused vehicle planning can still be helpful in BI reports; deleting the data would remove that visibility.

Similarly, manual planning is mainly motivated by AST use cases. It allows administrators to assign rides from planned vehicle plannings to manual ones. This gives administrators direct control over which ride is matched to which vehicle, which can be useful when a provider has multiple subcontractors.