Repository navigation
Starters and Leavers
Folder: starters/ Β· Colour: Golden brown #a16207 Β· New in 4.6.0
Everything that has to happen when someone joins, moves or leaves - on the right days, by the right teams - from one case.
A new starter needs an account, a laptop, a phone and access to the right systems before their first day. A leaver needs all of it taken back on their last. Each job belongs to a different team and has its own deadline, and the usual way of keeping track - an email to five people and a spreadsheet - loses something every time.
Starters & leavers is built from the modules you already use. The work is tasks in Tasks, kit is custody in Assets, the person is the one in Users, and anything automatic is a workflow. Nothing is kept twice, so everything those modules already do - notifications, checklists, history, the handover document - works here as well. (How it is built: Starters & leavers - Developer Guide.)
System β Demo data β Starters & leavers fills the module with a worked example: a New starter request form on the portal (who is joining, mailbox, private mailbox, DMS and PMS access, equipment), four templates - Legal starter (chosen when the department is one of the legal ones), Standard starter, Role change and Leaver - and nine cases at every stage. Priya Shah, joining Dispute Resolution next week, needs DMS access but not the PMS, and a laptop and a phone but no monitor, so her case has no PMS or monitor step. There is a starter waiting for answers, one who started three days ago with the walkthrough overdue, a finished one, a cancelled one, a leaver whose laptop is still to come back, and a mover.
Import Core, Assets, Checklists, Forms and Tasks first: a case's steps are tasks and its answers are a form submission, so they come with those modules' demo data. Re-import Starters & leavers after re-importing Tasks or Forms, to link the cases up again. Like all demo data, it is marked as such and removed without touching your own cases.
| Page | What it shows |
|---|---|
| Cases | Every case in the companies you can see: the person, starter / mover / leaver, the date (and how soon), the template, a progress bar, the owner and the status. Filter by kind and status, search by name or email. Open cases come first, soonest date first. |
| A case | The person and the date, then its steps (each a task, with who has it and when it is due), kit (from Assets), the account (for a leaver), documents and the history. |
| Settings β Templates | What should happen for each kind of change. |
| Help | The in-app guide. |
New asks:
- What is happening? - a starter (someone joining), a mover (a new role, team or office) or a leaver.
- Who? - a starter can be somebody not in Users yet: give their name and, if you know it, their email and job title. Movers and leavers are always somebody already in Users, found by name or email.
- The date - the first day, the move date or the last day.
- Owner - who looks after the case (you, by default).
- Template - the steps to add (see below). None opens just the case.
The case itself becomes a task, due on the date, called something like Leaver: Jane Smith (31 Oct 2026). Each step of the template becomes a subtask of it, given to the step's team or analyst and due its number of days from the date. So the work is on the Tasks board for the people doing it, with Tasks' own notifications, and the case reads its progress straight back - close a step in Tasks and it is ticked on the case.
If a step cannot be added (a team that has since been deleted, say), the case is still opened with the others, and its history says which step failed and why.
Settings β Templates (permission: Manage templates). A template is for one kind - starters, movers or leavers - and lists its steps:
| Column | Meaning |
|---|---|
| Step | What has to happen - "Order a laptop", "Disable the account". |
| Team / Analyst | Who it goes to. Either, both or neither. |
| Days | When it is due, from the case's date: -5 is five days before, 0 is on the day, 2 is two days after. |
| Checklist | A checklist from Tasks, attached to the step's task - for a step with several parts, like building a laptop. |
Changing a template never changes cases already opened from it - their tasks are already made. Switch a template off to stop offering it without deleting it.
Every company asks different things about a new starter - Will they need DMS access? A private mailbox? A company laptop? - so the questions are yours, built in Forms. Each template can use one form, or none. Forms and checklists are independent: a template can have either, both, or neither.
On the template (Settings β Templates):
| Setting | What it does |
|---|---|
| Questions | The form this template asks. None = a template that works exactly as above. |
| Use this template when | When a form opens a case, which template it gets: Department is any of Dispute Resolution, Property β Legal starter. The first template whose rule the answers meet is used; one with no rule is used when no other matches. |
| Only if (per step) | The step is added only when the answers say so: only if DMS access? is Yes. Operators: is, is not, is any of, contains, is filled in, is blank - the same as a form's show/hide rules. |
| {Question} in a step | The answer goes in: Create account for {Full name} - {Job title}, {Department} becomes Create account for Sarah Jones - Senior Associate, Dispute Resolution. The chips above the steps insert them. {name}, {email}, {job title} and {date} come from the case. A name that is not a question is left as typed, so a typo shows. |
Rules and {Question} use the question's wording, so a new version of the form keeps working as long as the question is still called the same thing.
Two ways the questions get answered:
-
A manager in the portal. Publish the form in the request catalogue, and in Forms add the action Open a Starters & leavers case to the form's actions - on submit, or on approval if HR signs off first (request approvals work as usual). The case opens itself: the name, email, date and job title are read from the answers (a question called Name, the first email question, the first date question, Job title / Role), or from the action's own boxes, which take
{{submission.fields.Start date}}style values. A mover or leaver is matched to Users by email; if nobody matches, the case opens with the typed name and Link joins it up. No template matched? The case asks the analyst to Use one. - An analyst on the case's task. Choose a template with questions in New, and the form goes on the case's task (forms on tasks) - its steps arrive as soon as the questions are answered there. Needs Tasks β Settings β Checklists β Forms on tasks; the case says so if it is off.
The analyst then works from the answers. The case page shows every answer with a Copy button, and the answers are written into the case's task in Tasks, so whoever picks up a step has them without opening the form.
Once a case is linked to a person, Kit lists everything they hold in Assets.
- Issue - find an asset by name, model or serial and give it to them.
- Recover - take one back, and optionally set its status at the same time: In stock, Awaiting wipe, or a status ticked Retired, which retires the asset with the date as anywhere else.
- Handover - the Assets handover document for the person, listing what they hold, ready to print and sign.
Both Issue and Recover are the same custody change Assets makes, so each asset's history, the asset.assigned / asset.unassigned events and any workflow listening for them all see it. Kit needs access to Assets as well as to Starters & leavers.
A starter added to Users after their case was opened: on the case, Person β Link joins them up, and Kit appears.
On a leaver's case, Account β Left switches the person off in Users - exactly what the person screen does - with the date. Their tickets, assets and history stay as they are.
A person kept up to date from a directory (LDAP, Entra, CardDAV) is not switched off here: the next sync would switch them straight back on. The case says so; disable them in the directory and the sync marks them as left.
Done closes the case, Cancel shelves it, Reopen brings it back. None of them touches the tasks: a step still open is somebody's work, and closing it quietly would hide that. Done asks first, and says how many steps are still open.
Anyone working on a case can mark it done. Cancelling and reopening are for the case's owner or somebody with Manage Starters & leavers.
Two Workflow triggers:
| Trigger | Fires when |
|---|---|
A starter, mover or leaver case is opened (jml.case_created) |
A case is created - after its steps are in Tasks. |
A starter, mover or leaver case is marked done (jml.case_completed) |
Done is chosen. |
Both carry jml_case.id, kind, person_name, person_email, user_id, effective_date, status, template_name and parent_task_id, so a workflow can check the kind or the template first - "if a leaver, email HR and post in #it-ops". Each step is an ordinary task, so the task triggers fire for them too.
People shows a Joining, moving and leaving section on a person's page: each of their cases with its date, status and how many steps are done.
A case belongs to the person's company; a starter not yet in Users belongs to the company you are working in. Analysts see the cases of the companies they can see - a case in another company reads as not found. Templates are shared by every company.
| What | Needs |
|---|---|
| See, open and work on cases | Access to the Starters & leavers module |
| Issue and recover kit | ...and access to Assets |
| Change templates |
Manage templates (starters.templates) |
| Cancel or reopen any case |
Manage Starters & leavers (starters.manage), which also covers templates - or be the case's owner |
When an analyst leaves, the analyst-leaving tool lists the open cases they own and hands them on with the rest of their work.
Four cards: a template with steps, a first case, a step with a checklist, and a workflow on a Starters & leavers trigger.
FreeITSM β an open-source IT Service Management platform Β· github.com/edmozley/freeitsm Β· MIT licence
- Installation
- β° Scheduled tasks (cron jobs)
-
Architecture
- β³ π§Ή Root folder tidy (URL routing)
- β³ π Database Integrity (FKs & constraints)
- β³ π οΈ Database Verification β Developer Guide
- β³ π§© Service Layer (UI + API share code)
- β³ πͺ€ Code traps (the TRAP: comments)
- β³ π Commenting for the Engineering wiki
- β³ π οΈ Engineering wiki scanner - Developer Guide
- β³ π Service-Layer progress
- π€ Contributing (read before a pull request)
- π§ͺ Developer tests
- π PDF exports moved to PDFKit (#254)
- AI Providers
- Internationalisation (i18n)
- Timezones & Time Handling
- π Date & Time Formats
- π± Currencies
- π§ The sidebar (optional module rail)
- π§© Preference templates
- π Display order (modules, Watchtower cards) β Developer Guide
- Theming & Dark Mode
- ποΈ Recent β getting back to what you were doing
- β¨οΈ Command palette (βK)
- π Searching inside tickets
- π Attached documents
-
MobileβFriendly
- β³ π« Mobile: Tickets
- β³ π» Mobile: Assets
- β³ π Mobile: Calendar
- β³ π Mobile: Knowledge
- β³ π¦ Mobile: Service Status
- β³ πΌ Mobile: Watchtower
- β³ π§© Mobile: Problem Management
- β³ π Mobile: Change Management
- β³ πΏ Mobile: Software
- β³ β Mobile: Tasks
- β³ π Mobile: Forms
- β³ π Mobile: Contracts
- β³ π Mobile: Domains
- β³ π Mobile: People
- β³ π Mobile: Projects
- β³ ποΈ Mobile: Files
- β³ π Mobile: LMS
- β³ πΊοΈ Mobile: CMDB
- β³ πΊοΈ Mobile: Network Mapper
- β³ π§ Mobile: Process Mapper
- β³ βοΈ Mobile: Workflow
- β³ π₯οΈ Mobile: System
- β³ π Mobile: Reporting
- β³ π Mobile: System Wiki
- β³ π Mobile: Self-Service Portal
- β³ π§° Mobile: Techniques & Tricks
-
Security
- Layer 1 β which modules you can enter
- β³ π§© Module Access Control
- β³ π οΈ Module Access β Developer Guide
- β³ π Switching modules off
- β³ π οΈ Module availability β Developer Guide
- β³ π Module availability β design (#217)
- Layer 2 β what you can administer
- β³ π Roles & Permissions
- β³ π οΈ Roles β Developer Guide
- β³ π€ Why capabilities are constants
- Layer 3 β the System module
- β³ π Admin Access Control
- Hardening
- β³ π Security review response 2026-08
- β³ π‘οΈ Security hardening 2026-08
- β³ π οΈ Security hardening 2026-08 β Developer Guide
- β³ π‘οΈ Round three β plain English
- β³ π οΈ Round three β Developer Guide
- β³ π‘οΈ CSRF protection (S4) β Developer Guide
- Single Sign-On (SSO)
- ποΈ LDAP & Active Directory
-
π¦ Microsoft Entra ID
- β³ π₯ Importing people and groups
- β³ π» Intune: assets to their primary user
- β³ π’ Organisation chart
- β³ π οΈ Entra directory sync β Developer Guide
- β³ π οΈ Entra import - review (#235)
- β³ π οΈ Entra follow-ups - review (#237-#240)
- β³ π οΈ Intune primary user - review (#236)
- β³ π οΈ Organisation chart - reviews (#242, #265)
- π CardDAV contact sync
- Browser Extension
- API Reference
-
π REST API β how it works
- β³ π Proposal: custom fields, inventory import and change evidence (#194)
- β³ π οΈ Custom fields, evidence + inventory - review (#195-#197)
- β³ π οΈ Long forms in a task's Work view - review (#198)
- β³ π οΈ Empty Procedures fold - review (#247)
- β³ π« REST API: Tickets
- β³ π» REST API: Assets
- β³ π΄ REST API: Problems
- β³ π REST API: Changes
- β³ π REST API: Knowledge
- β³ β REST API: Tasks
- β³ ποΈ REST API: CMDB
- β³ π REST API: Contracts
- β³ ποΈ REST API: Calendar
- β³ πΏ REST API: Software
- β³ π REST API: Domains
- β³ π¦ REST API: Service Status
- β³ βοΈ REST API: Morning Checks
- β³ π REST API: Forms
- β³ βοΈ REST API: Workflow
- β³ π·οΈ REST API: Cost centres
- β³ π§βπΌ REST API: Analysts
- β³ πΊοΈ REST API: Network Mapper
- β³ π§ Using the API docs page
- β³ π OpenAPI specification
- β³ β OpenAPI: kept correct
- β³ π οΈ Maintaining the catalogue
- Watchtower
-
Tickets
- β³ π Live updates
- β³ π οΈ Watching a ticket - Developer Guide (1 of 2)
- β³ π οΈ CSAT delay and reminder - Developer Guide
- β³ π οΈ Ticket checklist step types - Developer Guide (1 of 2)
- β³ π οΈ Right-click Attach checklist - Developer Guide
- β³ π οΈ Checklists in the REST API - Developer Guide
- β³ π οΈ Inbox.js map β Developer Guide
- β³ π οΈ Floating windows & the file viewer β Developer Guide
- β³ π οΈ Tickets settings β Developer Guide
- β³ π Simpler ticket and task forms - design (#218)
- β³ ποΈ The ticket workspace
- β³ π Forms on tickets
- β³ π The ticket table
- β³ π Rota copy and paste β Developer Deep Dive
- β³ β Checklists & SOPs
- β³ βοΈ Mandatory fields
- β³ π§Ύ Custom ticket fields
- β³ π·οΈ Ticket categories
- β³ π§Ύ A type for every new ticket
- β³ π₯ Assigning tickets to a team, and escalation
- β³ π’ One board across every company
- β³ π Ticket dashboard β Developer Guide
- β³ Mailbox Authentication
- β³ π€ Email send log
- β³ π Attachment size limits and large emails
-
β³ Basic IMAP mailboxes
- β³ π Basic IMAP without the PHP extension (#257)
- β³ π οΈ Basic IMAP client β Developer Guide
- β³ π§ͺ Basic IMAP client β Testing and verifying
- β³ π οΈ Basic IMAP - Sent copy - Developer Guide (#270)
- β³ π οΈ Verifying a mail folder β Developer Guide
- β³ π οΈ Mailbox providers β Developer Guide
- β³ π οΈ How Gmail mail collection works β Developer Guide
- β³ Email rendering & images
- β³ SLA Management
- β³ WhatsApp channel
-
β³
βοΈ Telegram channel - β³ β CSAT company scope and filters β Developer Guide
- β³ π₯ Microsoft Teams channel
- β³ π¨οΈ Mattermost channel
- β³ π¬ Web chat channel
- β³ π£ Slack channel
- β³ π Linking tickets
- β³ β Record previews
- β³ π Ticket notes: internal or shared
- β³ ποΈ Canned responses
- β³ βοΈ Limiting replies to particular senders
- β³ π¨ Telling the analyst a ticket is theirs
- β³ βοΈ Email signatures
- β³ π The public web address
- β³ π’ Ticket numbering
- β³ π Raising a ticket for someone else
- β³ π Merging tickets
- β³ π Confidential tickets
- β³ π₯ Portal managers
- β³ π Who has seen a ticket
- β³ π Reading long tickets
- β³ β Splitting tickets
- β³ β Selecting several tickets
- β³ ποΈ The folder pane
- β³ π½ Just my tickets, or no closed ones
- β³ π οΈ Snoozing tickets β Developer Guide
- β³ π₯ Collision detection
- β³ β±οΈ Time tracking
- β³ π Case reports - a ticket and its work as one PDF
- β³ π Scheduled work in your own calendar
- Problem Management
-
Tasks
- β³ π οΈ Task board and subtasks β Developer Guide
- β³ π§βπ€βπ§ People on a task ("Involved")
- β³ π Repeating tasks
- β³ π’ Moving a task between companies
- π Projects
-
Assets
- β³ π’ Moving an asset between companies
- β³ π Shared asset locations
- β³ π§βπΌ Assigning assets to analysts
- β³ π Warranty and lease alerts
- β³ π Leases
- β³ π Saved table views
- β³ π¨οΈ Recording anything, and importing it
- β³ π§© Asset type layouts
- β³ π Inventory freshness
- β³ π Linked configuration item
- β³ π Connected assets
- β³ π Asset review
-
β³ π·οΈ QR asset labels
- β³ π οΈ QR asset labels β Developer Guide
- β³ π Asset label designer - design (#229)
- β³ π· Asset scanning β Developer Guide
- β³ π οΈ Asset tag numbering β Developer Guide
- β³ π οΈ Asset reconciliation β Developer Guide
- β³ π οΈ Reconciliation, tags + labels - review (#164)
- β³ π Who holds what, and handover documents
- β³ π₯οΈ The inventory agent (PowerShell)
- β³ ποΈ Proxmox VE servers
- β³ βοΈ VMware Cloud Director servers
- β³ πͺ Hyper-V and Failover Clusters
- β³ π Linking equipment to tickets
- β³ βοΈ Follow-up tasks on a ticket
- Knowledge
- Change Management
- Calendar
- Morning Checks
- Reporting
- Software
-
Forms
- β³ π¨ The form designer β Developer Guide
- β³ π Layout & the grid β Developer Guide
- β³ ποΈ Collections β grouping submissions
- β³ π Submissions as PDFs
- β³ β‘ What happens next β a form's own actions
- β³ π οΈ Sections & conditional logic β Developer Guide
- β³ π οΈ Lookup fields β Developer Guide
- β³ π‘οΈ Catalogue request approvals
- People
- Starters & leavers
- Domains
- ποΈ Files
- Contracts
- Service Status
- π Notifications
- π¨ War Room
- Self-Service Portal
- LMS
- Process Mapper
-
CMDB
- β³ π οΈ CMDB β Developer Guide
- β³ π οΈ Impact analysis β Developer Guide
- β³ π οΈ Data quality β Developer Guide
- β³ π Linked assets
- β³ π Linking an asset to its CI - design (#201)
- β³ π Discovery and redundancy-aware impact - design (#199)
- β³ π οΈ Relationship wording - review (#297)
- Network Mapper
-
Workflows
- β³ π οΈ Workflow engine β Developer Guide
- β³ π οΈ Workflows for tasks β Developer Guide
- β³ π οΈ Workflow notes on a ticket β Developer Guide
- β³ π οΈ Workflow category routing β Developer Guide
- β³ β° Time-Based Triggers
- β³ πͺ Webhooks
- β³ π¬ Webhook Message Formats
- β³ π HTTPS Certificates & CA Bundles
- β³ π οΈ SSL Verification β the Global Setting
- β³ π Workflow & Webhook Pitfalls
- Issue trackers (Jira, Azure DevOps)
- π‘ Zabbix (monitoring)
- π¬ Microsoft Teams alerts
- π 3CX (phone system)
-
System
- β³ π οΈ Preferences β Developer Guide
- β³ π§Ή Maintenance
- β³ π Finding people in the Analysts list
- β³ πͺ When an analyst leaves
- β³ π οΈ System β Branding β Developer Guide
- β³ π©Ί Page health (D019) β Developer Guide
- β³ β Feature Bingo
- β³ π·οΈ Cost centres
- β³ π· Photo Album
- β³ Demo Data
- β³ π οΈ Demo Data β Developer Guide
-
Overview
- β³ π Progress tracker
- β³ Concepts & vocabulary
- β³ Email routing & mailboxes
- β³ Settings: global vs per-company
- β³ Users & self-service
- β³ Staff cross-company access
- β³ One company supporting another
- β³ π’ One board across every company
- β³ Worked examples
- β³ Pitfalls & gotchas
- β³ Scope: what it's for
- β³ π οΈ Developer Guide (make a module multi-company)
- β³ ποΈ Case study: CMDB (a linked graph)
- β³ π§ͺ Test harness (prove it's isolated)
- What this is
-
π Bugs resolved
- β³ π #301 CSAT delay was never applied
- β³ π #281 Comments imported from Jira never arrived
- β³ π #288 A change failed to open with Enforce approvals on
- β³ π Long non-Latin articles never got an embedding
- β³ π« #280 Email lookups scanned the whole table
- β³ β #266 Dragging a task told nobody
- β³ π #255 Article previews showed HTML codes
- β³ π #252 A link to a Knowledge article did not open
- β³ π #254 PDFs could not print Polish
- β³ π #250 Clicking a folder left the open article on screen
- β³ π« #260 The dashboard cog did nothing
- β³ π« #248 A department rule never matched on four routes
- β³ π A directory account could be matched to someone else
- β³ π« #244 Reply went to the assigned analyst
- β³ π A lookup answer could name any record
- β³ π« #227 A mailbox could not be deleted
- β³ π« #226 A picture on a note could not be closed
- β³ π» #222 The Assets page never loaded in 4.3.0
- β³ βοΈ #214 A "contains" condition did not match capitals
- β³ βοΈ #216 A workflow email from a chosen mailbox always failed
- β³ π³ The Docker image was missing PHP extensions
- β³ π A failed DNS lookup read as a missing record
- β³ π A link could change data
- β³ π Access outlived its removal
- β³ π Knowledge articles could run scripts
- β³ π Knowledge writes ignored permissions
- β³ π Company boundaries (Oct 2026)
- β³ π Smaller gaps (Oct 2026)
- β³ π Escaped text could leave its attribute
- β³ π Task descriptions were not cleaned
- β³ π Task documents ignored company scope
- β³ π Repeating tasks ignored company scope
- β³ π¬ #183 Mailbox checks overlapped
- β³ π #188 Transfer lock shown off when unknown
- β³ β #184 Subtask names and Overdue
- β³ π§© #186 Teams: the buttons did nothing
- β³ π Text in a change could run script
- β³ π AI settings changed without the AI permission
- β³ πͺ #178 Deleting an analyst failed
- β³ π« A team with no departments showed 0 tickets
- β³ π Projects: adding a phase did nothing on Save
- β³ π Leavers could still sign in
- β³ πΌοΈ Logo and courses broke on Apache with PHP-FPM
- β³ π’ Chat tickets ignored your ticket numbering
- β³ π Dates shown as a dash, or in server time
- β³ π Assets β Users showed people from other companies
- β³ π Restricted analysts could read other modules' data
- β³ πΌοΈ Replies with a picture in the thread failed to send
- β³ π Reply attachments never reached the customer
- β³ π οΈ Outbound email attachments β Developer Guide
- β³ π A global SSO provider was missing from the portal
- β³ π Behind a proxy, the SSO redirect said http
- β³ βοΈ The portal tagline moved when you saved it
- β³ π¨ The portal settings screen forgot what you saved
- β³ π‘οΈ The approvals inbox said "Error" and nothing else
- β³ π A table's answers were missing from the PDF
- β³ β A single-select column let you tick every option
- β³ π The portal ignored a form's field widths
- β³ π The tasks board stopped taking clicks
- β³ ποΈ #121 The index list is out of date after upgrading
- β³ π #133 The calendar subscription was empty
- β³ π #131 Tasks always reopened on the board
- β³ π₯ #129 Every page returned HTTP 500 after upgrading
- β³ π³ #127 A PHP warning above the System page
- β³ π #126 Notes stamped with the server's clock
- β³ π Storing every date in UTC
- β³ πͺ The portal was down for everyone signed in
- β³ βοΈ #120 Workflow notes could never be written
- β³ βοΈ #123 Three errors when running Database Verification
- β³ π #122 The description box was a stub in the corner
- β³ π£ Demo data deleted real accounts
- β³ π #117 Sign-in redirected to the wrong address
- β³ π¨ #108 The priority dot was invisible
- β³ β±οΈ #116 Time logged from the right-click menu
- β³ π #114 API keys refused by our own guard
- β³ ποΈ #110 Assigning a task told nobody
- β³ πͺ #107 Signed out while still working
- β³ π #103 "Share with Requester" reached nobody
- β³ π #102 Search found nothing for hyphens
- β³ πͺ #101 Source code editor opened behind
- β³ βοΈ #88 Subtasks could not be ticked off
- β³ π» #84 Asset deep link selected nothing
- β³ π« #79 A new ticket arrived with no status
- β³ π§ #79 A ticket from email did not say so
- β³ π #78 Bell opened to nothing
- β³ π¬ #77 Mail only collected from Inbox
- β³ π #74 The default password could not be changed
- β³ π¦ #70 Renaming an impact level
- β³ π€ #67 App-only mailboxes could not send
- β³ π #45 Verify only ever worked for Microsoft
- β³ π #45 IMAP reported as not authenticated
- β³ βοΈ An email template stopped escaping itself
- β³ π The portal dashboard showed the wrong time
- β³ π’ The folder said 99 and the list showed 96