Skip to main content

Onboarding & offboarding

Your workspace tracks the full employee lifecycle. When you add a new hire, an onboarding pipeline is created automatically. When someone leaves, you open a separation that walks HR through a clearance checklist and a one-click final settlement. This page covers both.

  • Onboarding lives at /admin/onboarding
  • Activity plans (checklist templates) live at /admin/onboarding/plans
  • Probation confirmations live at /admin/employees/probations
  • Offboarding lives at /admin/offboarding

Onboarding​

The pipeline is created for you​

You do not start onboarding by hand. The moment you create an employee, a pipeline with a default checklist is spawned for them and appears under Onboarding (/admin/onboarding). Each pipeline shows the employee, designation, joining date, a status, and a progress bar. Rehiring a former employee starts a new pipeline the same way, in place of their earlier one.

An onboarding checklist in progress

A pipeline starts in one of two statuses depending on the joining date:

StatusMeaning
PreparingJoining date is still in the future.
Day 1Joining date has arrived.
RampingAt least one task is done and the employee has joined.
CompletedAll required tasks are done or waived.
CancelledPipeline was closed without completing: by HR, or automatically when the employee's final settlement is completed.

The status advances on its own: Preparing flips to Day 1 once the joining date passes, and the pipeline auto-completes when every required task is finished.

The default checklist​

Every new pipeline is seeded with the same twelve tasks, plus Issue ID card once Brand Studio is unlocked. Due dates are set relative to the employee's joining date (some fall before day one). An activity plan adds the steps your workspace, a department or a job title needs beyond these, or replaces them.

TaskWhen it's dueHow it's done
Send pre-joining email7 days before joiningClick Run to send the welcome + documents email
Prepare computer2 days before joiningManual — tick it off yourself
Create portal accountJoining dayCloses itself once a login exists for the employee
Assign salary structureJoining dayOpens /admin/payroll/salaries; closes when a salary is assigned
Create employment contractJoining dayOpens /admin/contracts/create; requires a salary structure first (the contract states the same gross salary payroll pays); closes itself once a contract exists
Contract accepted or signedJoining dayOpens /admin/contracts; closes itself once the employee accepts in their portal or HR uploads the signed copy
Enroll on biometric deviceJoining dayClick Run to push to the attendance device. Needs a plan that includes biometric devices — otherwise the button shows a lock; the task still closes itself if the employee is already on a device, and you can waive it
Issue assets (computer, SIM, badge)Joining dayOpens /admin/assets; closes once any asset is issued
Day-1 orientationJoining dayManual
Send welcome email1 day after joiningClick Run to send
Confirm leave group assignment3 days after joiningOpens /admin/leave/groups; closes when a leave group is set
Schedule probation review30 days after joiningCloses when a probation appraisal exists (see below)
Issue ID cardJoining dayOnly once Brand Studio is unlocked, and optional. Opens the ID Cards page with the issue dialog for the employee; closes itself once a card is issued to them
info

Contract accepted or signed is the task that activates the employee. Until it is done, they stay New (Pending Activation) and are excluded from payroll, attendance, and leave. See Employees for statuses and activation, and Contracts & HR letters for the two ways a contract gets signed.

Tasks come in three kinds:

  • Manual — you mark them done.
  • Action — they have a Run button that performs the step (send an email, push to biometric, schedule the probation review).
  • Link — they open the relevant admin screen so you can complete the work there.
note

When new default tasks are added to the product, onboarding pipelines still in flight pick them up automatically — opening a pipeline backfills any checklist items it is missing, with due dates computed from the joining date. Completed or cancelled pipelines are history and are never touched, and backfilling only ever adds tasks — it never alters or reopens existing ones.

Tasks that complete themselves​

Several tasks watch the real state of your workspace and close automatically. Each time you open a pipeline, the system re-checks whether the underlying work is already done and ticks the task off — for example, it marks Assign salary structure done once an active salary assignment exists, Create employment contract done once any contract exists for the employee, Contract accepted or signed done once a contract is accepted electronically or a signed copy is on file (its summary notes that the employee was activated), Issue assets done once any asset has been handed to the employee, and Enroll on biometric device done once the record is on a device. For a rehired employee, the contract, asset and probation-review checks count only what was made after the rehire, not what the earlier employment left on file.

Each task closed this way keeps a short note of what the check found, with amounts in your workspace currency, dates written out, and the contract type by its name: for example Active salary assigned (gross $ 5,600, effective 15 Oct 2026). or Contract NWL-CTR-0050 created (Permanent, starts 15 Oct 2026).

note

Auto-checks only ever move a task forward to Done. They never re-open a task you completed and never override one you Waived.

You can also assign a task to a specific user; they receive a notification email, and can mark the task done themselves (see What the person a task goes to can do). When all required tasks are Done or Waived, the pipeline is marked Completed and a completion email goes to the employee.

Managing onboarding requires the onboarding.manage permission; viewing requires onboarding.view.


Activity plans​

The built-in checklists are the same for everyone. An activity plan is a checklist template of your own: the steps a new joiner, a leaver, a transferred or a promoted employee owes and is owed, who each step lands with, and when it is due. Plans live under Onboarding › Plans (/admin/onboarding/plans). Reading them needs activity_plans.view; writing and applying them, activity_plans.manage (HR Manager and Super Admin by default; HR Officer and Department Head can read).

How a plan is picked​

Every plan has a kind (onboarding, offboarding, transfer or promotion) and says who it is for:

  • For a job title, with or without a department. The closest match.
  • For a department. Used when no job-title plan matches.
  • The default for its kind. Used when nothing closer matches. One default per kind; making a plan the default unsets the previous one.
  • Neither. The plan is only ever applied by hand.

When an employee is added, their onboarding pipeline looks for an onboarding plan in that order: the plan for their job title, else their department, else the default. A separation does the same with offboarding plans; a transfer or promotion with plans of that kind, against the department and job title the person moves into. A workspace with no plans gets exactly the checklists it always did. A retired plan is kept for the record but never picked.

What a plan contains​

Each item of a plan becomes one task on the checklist, in the plan's order (drag the handle or use the arrows in the editor). An item says:

SettingMeaning
Goes toHR leaves the task unassigned for any HR user. Manager is the employee's reporting manager; Employee the person themselves (once they have a portal account); Buddy the colleague named as buddy on the pipeline; IT and Finance the users named at the bottom of the Plans page; Named user one specific user. Someone who cannot be resolved (no manager, no portal account yet, no buddy named) leaves the task unassigned, with the role still shown on it so HR knows who it is meant for. A Manager, Employee or Buddy task on an onboarding, transfer or promotion checklist does not stay that way: once the person has a manager, a login or a buddy, the task goes to them the next time the checklist is opened, or when they open their own Checklist Tasks page, and they get the task-assigned email.
DueA number of days from the start of the event (joining date, notice date, transfer or promotion date) or, for offboarding, from the end (the last working day, else the separation date). Negative for before.
Task typeTick off by hand; Link to a page (a path in the app, where {employeeId} is replaced by the person's id); or, on onboarding plans only, Run an action: the pre-joining or welcome email, biometric enrollment, the probation review, or Send a survey with an onboarding day-30 or day-90 trigger (Surveys). Offboarding items are always ticked by hand.
RequiredEvery kind of plan. A required task holds the checklist open until it is done or waived; an optional one does not. On an offboarding plan, an optional item shows on the clearance marked optional and can be ticked, but the clearance completes without it. Items on a clearance opened before optional offboarding items existed stay required.

An onboarding or offboarding plan also chooses whether to keep the built-in checklist. On, the built-in tasks are seeded first and the plan's items follow them, so the contract, salary and clearance automation stays. Off, only the plan's items go in.

A checklist keeps the shape it was created with. An onboarding created without the built-in tasks never gets them later: not when its plan is deleted, and not when Keep the built-in checklist is switched back on. Both change the checklists created from then on.

Preview on the editor shows what the saved plan produces for a real employee: each item with the person it would land with and its due date. Save first; the preview reads the plan as stored.

Buddies, IT and Finance​

A pipeline can name a buddy: the colleague who shows the joiner around. Name one on the pipeline page and the plan's buddy tasks that were still unassigned go to that person, with the task-assigned email. The IT and Finance roles resolve to the two users named at the bottom of the Plans page; leave one empty and those tasks stay with HR.

What the person a task goes to can do​

A task lands with a manager, a buddy, the employee, IT or Finance, and none of them needs onboarding.manage or offboarding.manage to deal with it. Each has a Checklist Tasks page in the portal (/portal/checklist-tasks, under Work in the sidebar, shown to anyone who has tasks). It lists the tasks assigned to them on checklists that are still open, each with the person it is for and its due date, and lets them:

  • Mark done. The task is completed in their name, and it counts on the checklist exactly as a tick from the checklist page does: when it is the last required task, the checklist closes.
  • Undo a tick they made themselves, while the checklist is still open.

That is all the page does. It cannot reassign a task, change a due date, waive anything or show the rest of the checklist. Two kinds of task are listed but not ticked there: one that runs an action (it is completed by running the action, from the checklist) and a clearance item that follows the records, such as assets returned or loans settled.

The button in the task-assigned email opens this page. For someone who can open the checklist itself (onboarding.view, or offboarding.view for a clearance item) it opens the checklist instead.

Applying a plan by hand​

A plan can also be applied to a checklist that already exists, from the plan (Apply to a checklist) or from the pipeline or separation page (Apply a plan). Its items are appended after the tasks already there; items the checklist already took from that plan are skipped, so applying twice adds nothing. A completed, cancelled or settled checklist cannot take new tasks.

The people the added tasks land with are told as they are when a checklist is created with a plan: one task-assigned email for each task that has someone to go to. The same happens when a separation is opened with an offboarding plan, and when a transfer or promotion checklist is started by hand.

Transfer and promotion checklists​

A transfer or promotion plan opens a checklist when the movement is recorded, if a plan of that kind matches the employee's new department or job title; nothing is opened otherwise. The checklist lives with the onboarding pipelines (Onboarding, filtered by kind), is dated from the transfer date, or for a promotion from its effective date when one is set (the promotion date otherwise), and follows the same statuses and task actions. It does not send the onboarding emails or the onboarding.completed event when it closes. HR can also open one from the plan itself (Apply to a checklist, choose the employee and the date; left empty, the date is today on your workspace's calendar).

A movement has one checklist. A transfer or promotion that is saved twice, or reaches the server twice, still opens one, and the people its tasks go to are emailed once. Opened by hand, the same plan for the same employee on the same date gives you the checklist already open rather than a second copy; choose another date, or close the first, to start a new one.

When an employee leaves, their open transfer and promotion checklists are cancelled with their onboarding (see Complete the final settlement).

Probation & confirmation​

New hires with a probation end date appear on the Probations page (/admin/employees/probations). It lists everyone still on probation, when their probation ends, and how many days remain — overdue people are flagged in red. Use the Include overdue toggle to show or hide those whose probation has already lapsed.

Reminders and automatic scheduling​

You don't have to watch this list every day. A daily job (09:15, workspace time) does two things:

  • Reminder digest — emails HR a summary of every employee whose probation ends within the next 14 days (and any already overdue).
  • Auto-schedule the probation review — when probation is within 30 days, it creates a "Probation Review" appraisal cycle for that person automatically, provided you have an active probation appraisal template. This is the same step the onboarding checklist's Schedule probation review task performs.

Confirming an employee​

When probation is over, click Confirm next to the employee. A dialog lets you:

  1. Set the Confirmation Date (defaults to today).
  2. Leave Auto-issue confirmation letter and email to employee ticked (recommended).

On confirm, the employee is stamped as confirmed, a confirmation letter is generated through HR Letters (using your active confirmation-letter template), and the employee is emailed — with the letter PDF attached when one was issued.

Confirming requires the employees.confirm permission.

tip

An employee can only be confirmed once. If you re-open the dialog on someone already confirmed, the action is rejected.


Offboarding​

Offboarding is handled through separations at /admin/offboarding. Each row shows the employee, separation type, dates, clearance progress, and the final settlement amount once settled.

An offboarding clearance checklist

Start a separation​

Click New Separation and fill in the form below. You can also start from the employee's profile: Start offboarding at the bottom of the Status menu opens this form with the person already chosen. That is also the way to offboard someone who is not Active (On Leave or Suspended, say), since the employee search here lists active employees only.

FieldNotes
EmployeeSearch active employees by name, code, or email
TypeResignation, Termination, Retirement, End of Contract, Death, or Absconding
Notice DateOptional
Separation DateRequired
Last Working DayOptional
ReasonInternal notes only — not shown to the employee

Creating the separation notifies HR and the employee (sent to both official and personal email, since the official mailbox is often disabled around separation).

Moving to another workspace of the group. When the workspace is in a group, a person who moves to another of its entities leaves through Move to another workspace instead of New Separation. It opens a separation of the type Moved within the group together with the move, and the other workspace adds them with their years of service. That type is never chosen on its own, cannot be changed while the move stands, and does not invite the person to an exit survey. See Moving a person to another workspace, including how end-of-service is carried or settled.

warning

An employee can have only one open separation at a time, and someone already marked separated cannot have a new one started. Settle or cancel the existing record first.

The clearance checklist​

Every separation opens with a clearance checklist of five items, plus Provident Fund settled for an employee with a provident fund and ID card returned for one who holds an active Brand Studio ID card not yet marked as returned. The auto-flagged items reflect live data and refresh each time you open the record:

Auto-flagged itemMarked done when…
Assets returnedNo company assets are still issued to the employee
Loans settledNo outstanding loan balance remains
Provident Fund settledA PF settlement type has been chosen (at settlement time). Only for an employee with a provident fund
ID card returnedEvery active ID card, and every card revoked since the separation was opened, is marked as returned in Brand Studio. Collect the card and click Mark as returned on it: an active card can be marked, and stays valid until completing the settlement revokes it. Only for an employee with an active ID card (added later if a card is issued during the notice period)

The other three are manual — HR ticks them off: IT access revoked, Knowledge transfer, and Exit interview.

An offboarding activity plan adds its own items after these (or replaces them), each with the person it goes to and a due date counted from the notice date or the last working day; the item shows who it is with, that person is emailed and can tick it on their Checklist Tasks page, and a plan can be applied to an open separation by hand. An item left required on its plan holds the clearance open until it is completed or waived; one marked optional does not. The built-in items are always required.

An employee has a provident fund when they have a PF ledger: PF contributions from payroll, an opening balance, or any other PF ledger entry. Provident Fund settled is left off everyone else's checklist. If an employee's first PF contribution is posted after their separation was opened, the item is added the next time you open the record. A separation that lists it for an employee without a provident fund shows it as done, with "No provident fund for this employee: nothing to settle."

Because auto-flagged items track real state, you cannot simply tick them Done — you resolve the underlying work (return the assets, clear the loan, collect the ID card) or mark the item Waived with a note. As items are completed, the clearance status moves from Pending to In Progress to Ready to Settle. Only when everything is Ready to Settle can you complete the settlement.

Preview the settlement​

The separation detail page shows a live Settlement Preview so you can see the numbers before committing:

  • Years of service and last basic salary, from the salary assignment in force on the last working day (or the separation date when no last working day is recorded). The last basic is the one payroll pays: what the salary structure's Basic component gives on the employee's gross. Only when the structure has no Basic component is the whole gross used.
  • Leave encashment — for each leave type whose policy allows encashment, the unused balance of the current fiscal year × the per-day figure, itemised by leave type. The per-day figure follows the policy's Encashment Basis: a multiple of the employee's daily basic pay (monthly basic ÷ 30), or a fixed amount per day (see Leave encashment). For a type that accrues monthly or quarterly, only the days accrued so far count.
  • A warning under the figures for each encashable leave type that cannot be priced: its policy has no rate, or it is priced in days of basic pay and the employee's salary structure gives no basic pay. That type's days are left out of the settlement, and stay in the balance, until you set the rate or add basic pay to the structure. Encashment never falls back to the gross.
  • Gratuity — the end-of-service award under the rule for your workspace's country. That rule sets the minimum service, the formula and the wage it is worked out on (basic, or the full wage). An employee below the minimum gets none, and the preview says how many years the rule needs. Where the country has no end-of-service gratuity rule, the preview shows Not applicable. See Multi-country & currency.
  • Provident Fund balance, for an employee with a provident fund. For anyone else the preview has no PF line, and its total reads Cash settlement.
  • Outstanding loans.

Complete the final settlement​

Click Complete Settlement to finalise. In the dialog you choose how to handle the Provident Fund (asked only for an employee with a provident fund; for anyone else no PF option is recorded) and whether to issue the experience certificate:

PF settlement typeEffect
Full withdrawal (paid to employee)PF balance is paid out and added to the cash settlement
Transfer to another PF trustPF is moved to a named trust — you must enter the recipient
Forfeit (write-down to zero)PF is written off and paid to no one

The final cash payout is:

final cash = leave encashment + gratuity + (PF only when withdrawal) − outstanding loans

You can override the auto-computed gratuity (for example, forfeiting it on a misconduct termination), and untick the experience-certificate option if you don't want one issued.

warning

If your workspace has a provident fund set up under Contribution funds that is paid into a fund account, a government body or a provider, the PF is paid from there, not from the salary account: it is left out of the cash settlement above, and a withdrawal or transfer is recorded on the fund as a leaver payout. A forfeit leaves the money in the fund. A provident fund kept on your books changes nothing here: the PF is paid with the cash settlement, as above.

Completing settlement is permanent. In one step it writes the PF ledger entry (for an employee with a provident fund), records leave encashment, posts the payout as a (non-taxable) payroll adjustment for the current month, and flips the employee's status to separated. If the employee's onboarding pipeline is still open, it is closed as Cancelled and the change is recorded in the activity log; so is any transfer or promotion checklist of theirs that is still open. If the net comes out negative — loans exceed everything else — it is posted as a deduction the employee owes. Separated is a terminal status written only by settlement — it cannot be picked by hand from the profile Status menu, the menu offers no other status for a separated employee, and a separated employee can no longer be assigned a salary structure. To employ the person again later, use Rehire on their profile: it starts a new employment on the same record and leaves this settlement as it is. See Rehiring a former employee.

After settlement, the experience certificate is generated through HR Letters and the employee is emailed a summary of the settlement with the certificate PDF attached (sent to official and personal email). Completing the settlement also revokes the person's active ID cards, so their QR codes stop verifying, and cancels their pending Brand Studio requests and visiting card orders not yet printed (see Brand Studio).

Paying the settlement​

Monthly payroll pays active employees only, so no payroll run pays a separated employee's settlement. Pay the Final Cash Settlement directly, by bank transfer or cheque, and keep your own record of the payment; a net amount the employee owes is collected the same way. The settlement's adjustment stays approved under Payroll › Adjustments, and it does not mark the month's payroll run as out of date.

The settlement does not include salary. Run and lock the employee's last month of payroll before you complete the settlement.

Account closure and the grace period​

A configurable grace period (default 30 days, set under /admin/settings/offboarding) governs when the person's access to your workspace ends. What closes at the end of it is the membership in your company — not necessarily the person's whole account:

  • Sign-in email is a personal address — the account stays active after the membership closes, ready for a future employer on the platform (and any other companies they belong to are untouched).
  • Sign-in email is a company-owned official address and no other active membership remains — the whole account goes dormant at closure: login and password reset stop working. This protects the person if your company later recycles that mailbox to someone else. A dormant account is revived only by a new invitation/membership, with a forced password setup.

A daily job, shortly after 10:00 workspace time, sends the "account closing soon" warning five days before the grace period ends and closes the membership once it has ended. Someone rehired before then with Invite to portal keeps their sign-in, and the job no longer counts down on that separation.

The seeded "account closing soon" warning email tells employees who sign in with a company address to switch to a personal one before closure (My Account → Sign-in & Security at /profile). Under the official-email-locked sign-in policy, that switch becomes possible at separation — the grace period exists precisely so it can be used.

Managing separations requires the offboarding.manage permission; viewing requires offboarding.view.


What HR sees by email​

EventWho is notified
Onboarding startedHR
Onboarding task assignedThe assigned user
Onboarding completedThe employee
Probation ending soonHR (daily digest)
Employee confirmedThe employee (with letter)
Separation initiatedThe employee and HR
Clearance completedHR
Final settlement paidThe employee (with certificate)