Automation reference

This page is a reference for developers and administrators. For the meaning of each option, see Configuration.

Scheduled actions#

All are ir.cron records in noupdate data, active when installed, with numbercall -1, and run as code on the model.

What each one selects:

• Recurring shifts. Series with type forever, or until with a date in the future, whose last_generated_end_datetime is empty or before the horizon (now plus Recurring Shift Horizon months). Series of type x_times are never selected.
• Reminders. For each company with reminders on: shifts that are published, of type planning, with a resource, starting after now and within Remind Before (hours), and whose reminder_sent_start differs from start_datetime. After sending, reminder_sent_start is set to the start.
• Utilisation. All resources, from 62 days back to 184 days ahead; rows older than the window are removed.
• Attendance. Published shifts of type planning with a resource that started and ended less than two days ago: refresh the attendance fields, then send missed-start alerts.
• Draft timesheets. Up to 500 shifts that ended in the last 31 days, of type planning, with a resource, on a project that allows timesheets, not yet marked timesheet_draft_generated.

Autovacuum jobs: smarterp.planning.recurrency._gc_empty_recurrences (removes series with no shifts) and smarterp.planning.broadcast._gc_old_broadcasts (older than 30 days).

Utilisation is also refreshed at commit through a pre-commit hook: create, write and unlink of shifts, and of calendar leaves, call smarterp.planning.capacity._mark_dirty, which queues the affected resource and dates; _flush_dirty merges them and refreshes once per transaction, with one day of margin.

Server actions#

Email templates#

The schedule and broadcast templates read the context key planning_employee_id to build the employee's link. All four use the layout mail.mail_notification_light, delete the mail after sending (auto_delete), and are noupdate.

Report#

smarterp_planning.action_report_planning_rota (QWeb PDF, model smarterp.planning.print, template report_planning_rota, paper format paperformat_planning_rota: A4 landscape, 90 dpi). The file name is Rota followed by the start date.

Public routes#

All routes use auth="public", are excluded from the sitemap, and answer 404 when a lookup fails.

After each action the browser is redirected to the week page with message or error in the query string. Pages set the language from the employee's user, or the contact, when installed. Templates: portal_planning_schedule, portal_planning_expired, portal_planning_broadcast_shift, with styles in portal_planning_styles.

Methods called by the front end#

These public methods are called with orm.call from the schedule and dashboard (see Data model):

planning_user_can_plan, get_planning_header_actions, get_planning_schedule_data, get_planning_card, get_planning_quick_create_defaults, get_planning_to_plan_items, planning_drop_item, planning_check_drop, planning_eligibility_map, planning_snapshot, planning_restore, action_planning_copy_to, action_planning_bulk_move, action_planning_bulk_assign, action_planning_bulk_unassign, action_planning_bulk_publish, action_publish, and get_planning_dashboard. Card buttons call the method named in the card's actions list.

Menus and window actions#

The wizards are window actions with target new: action_planning_send, action_planning_copy_previous_week, action_planning_auto_plan, action_planning_template_apply, action_planning_print, action_planning_split, action_planning_duplicate, and smarterp_planning_sale.action_planning_plan_orders.

First-use tour#

smarterp_planning_tour (web_tour.tours, sequence 90) walks a planner through creating a role and opening the schedule.

Next#

• Testing and upgrades