Skip to content

Help Centre

Onboarding & Setup

A configuration playbook for IT teams and super-users setting up a new PlainSail installation – follow the setup journey through people and access, documents, risk and compliance, and finally accounts, rates and billing.

ResourcesHelp Centre › Onboarding & Setup
Last updated June 2026

Key points

  • Set things up in order – later areas depend on users, user groups, and rate bands existing first
  • You need the Administrator role to reach every setup screen in this guide
  • Roles are granted through user groups; users inherit roles by being a member
  • Entity permissions decide which entities each user can see – separate from roles
  • New users are assigned the system currency and the default staff rate band automatically
  • Most reference data “deletes” by being marked not in use once it has been referenced

Overview & setup journey

This guide is for IT teams and super-users setting up a new out-of-the-box PlainSail installation. It walks through the configuration areas in the order they depend on each other, so that by the time you reach billing rates everything they rely on already exists.

All of this setup is done within PlainSail. Throughout the guide each area lists its menu path and its internal navigation address (shown as area/screen) so you can confirm you are in the right place.

You need the Administrator role Every setup screen in this guide requires the Administrator role. If a screen will not open, that is the first thing to check.

The setup journey at a glance

Configuration falls into five stages. Each one builds on the stage before, so working top to bottom means everything a screen relies on already exists by the time you reach it. Select any item to jump straight to its section.

Why the order matters Define user groups and entity permissions first, so that when you create users you can slot each person straight into the right roles and entity access. After that, risk ratings build on the country-risk scores, and time & billing build on users and the chart of accounts. Several stages also link out to dedicated guides where a feature is configured in more depth.

Pre-setup checklist

Before you start adding users, confirm the following are in place. New user records depend on them.

  • You are signed in with the Administrator role.
  • The company system configuration exists – creating or updating a user requires it.
  • A default currency (system currency) is set – new users are assigned it automatically.
  • A default staff rate band exists – new users are assigned it automatically (see Section 12).
  • User groups exist if you want to set a user’s Reports to or Team (those dropdowns are filled from user groups).
  • Entity permission groups exist if new users must see entities straight away – otherwise a newly created user sees nothing until added to one.

1. User groups

User groups collect users and roles together. Roles are assigned to a group, and every user in the group inherits those roles. Set up the groups you need before fine-tuning individual users, and remember that a user’s Reports to and Team values are chosen from user groups.

Where to find it

  • Menu path: Admin > Utilities > User Groups
  • Navigation address: admin/usergroups

Fields and panels

ControlWhat to enterRequiredNotes
NameA name for the group.YesMust be unique. Max 255 characters.
DescriptionWhat the group is for.YesMax 5000 characters.
Users panelAdd or remove members. The picker hides users already in the group.You cannot remove yourself, the system user, or the last administrator from the Administrators group.
Roles panelAdd or remove the roles granted to members.The Administrator role is not offered to non-admin groups, and the Administrators group’s roles cannot be changed.
Protected and internal groups Internal groups cannot be edited or deleted from the grid, and the Administrators group cannot be deleted or have its roles changed. Deleting a group warns that its members will lose any roles not also supplied by another group.

2. Entity permissions

Entity permission groups decide which users can see which business entities – this is separate from roles. A group has a name, an inclusion type, a set of entities, and a set of users.

Where to find it

  • Menu path: Admin > Entity Permissions
  • Navigation address: admin/entitiesallowed

Fields and controls

ControlWhat to doNotes
NameName the permission group.Required; must not duplicate an existing group.
TypeChoose the inclusion type (include or exclude).Changing it warns that entity access may change.
Entities / Users tabsSwitch between the entities in the group and the users in the group.
Drag/drop listsMove available entities or users into or out of the group.The global groups have restricted editing.
Show/Hide UsersInclude users in the entity list.Warns when adding users as entities to an excluding group.
Exclusion beats inclusion If a user is in both an including and an excluding group for the same entity, the entity stays hidden. Permission changes take effect immediately.

Useful extras: Who can see this? and What can they see? answer access questions for a chosen entity or user, and administrators can reset the global group to defaults with Fix Global Group. The global group cannot be deleted.

3. User setup

User setup creates and maintains the people who can sign in to PlainSail. A user is also a business entity behind the scenes, so creating a user also creates an entity record you can open and edit. With your user groups and entity permission groups already in place, you can place each new person into the right roles and entity access as you create them.

Where to find it

  • Menu path: Admin > Utilities > Users
  • Navigation address: admin/usersandgroups

The Users list screen

ControlWhat it doesDefault
Show logged in users onlyShows only users currently detected as signed in.Off
Show ‘can logon’ onlyHides users whose access has been switched off. Staff who have left are expected to have access removed rather than being deleted.On
Search boxFilters by part of the user’s full name or Windows name.Empty
Status dotRead-only indicator – green when the user is signed in.
Firstname / Surname / Windows nameRead-only columns. Shown struck through when the user cannot sign in.
Has accessRead-only icon showing whether the user can sign in. Edit the user to change it.
Is in these groups / Has these rolesRead-only panels for the selected user; click a group or role to jump to its setup.

Create or edit a user (manual form)

FieldWhat to enterRequiredDefaultNotes
Windows name *The full Windows/domain login.YesEmptyMust be unique. Max 100 characters.
TitleOptional title.NoEmptyMax 25 characters.
First name *The user’s first name.YesEmptyMax 100 characters.
Last name *The user’s last name.YesEmptyMax 100 characters.
Other namesMiddle or other names.NoEmpty
Email *The user’s email address.YesEmptyMust be a valid email format.
Start date *The date the user starts.YesToday
End dateThe date the user leaves.NoEmptyDoes not by itself stop sign-in.
Can logon?Tick to allow the user to sign in.NoTickedBlocked if the licensed user limit is reached.
Auto-approve time?Tick if the user’s submitted timesheets should approve automatically.NoOff
Hours per weekWeekly working hours. Use 0 to keep the user out of time recording/billing.NoSystem defaultBetween 0 and 168. For existing users this is read-only here – change it under Time Setup > Working Hours.
Target utilisation % *Target percentage of chargeable time.Yes0Whole number 0–100.
Reports toThe user group this person reports to.NoNoneSelect a user group.
TeamThe user group used as this person’s team.NoNoneSelect a user group.

Actions on this screen

ActionWhat it does
+ (manual add)Opens the create-user form with working hours pre-filled to the system default.
EditOpens the selected user. The protected system user cannot be edited.
DeleteHard-deletes if possible; otherwise just switches off the user’s access to preserve history. You cannot delete yourself or the system user.
ImpersonateTemporarily takes on the selected user’s roles (until restart or refresh permissions) to test access. The system user cannot be impersonated.

Worked example: create a new user

1

Open Admin > Utilities > Users.

2

Click the + manual add button. The form opens with working hours set to the system default.

3

Enter Windows name, First name, Last name, Email, Start date and Target utilisation %, plus any optional fields such as Team or Reports to.

4

Leave Can logon? ticked if the person should sign in. Set Hours per week between 0 and 168 (use 0 only to keep them out of time recording).

5

Click Save. The new user is given the system currency and default staff rate band, and added to the Standard User group if it exists.

6

When prompted, choose the entity permission groups the user should belong to. If you select none, you are warned the user will not see any entities.

Permission required The Users screen and all its actions require the Administrator role. PlainSail will add your IT Admin account to this by default.

4. Workspaces

Workspaces categorise document filing. Each workspace has a type, a name, the users and documents linked to it, and an optional “default for fast tagging” flag.

Where to find it

  • Menu path: Admin > Documents > Workspaces
  • Navigation address: admin/workspaces

Fields and controls

FieldWhat to enterRequiredNotes
NameThe workspace name.YesMust be unique. Max 255 characters.
TypeThe workspace type.YesNew workspaces offer Customer Record and Organisation Record.
Default for fast-taggingMarks this workspace as the default for fast tagging.NoSetting a new default automatically clears the previous one.
Deleting workspaces A workspace that is in use by documents cannot be deleted. Standard customer and organisation workspaces are available to everyone; personal/staff workspaces are limited to their creator or members.

5. Standard inventories & registers

PlainSail ships with a library of standard inventories and registers – structured data collections such as CDD questionnaires, risk assessments, and compliance registers (gifts & benefits, breaches, conflicts of interest, and more). Over 37 system templates are provided out of the box, and they can be configured to match your firm’s requirements.

Where to find it

  • Menu path: Admin > Inventories > Templates

System inventories are locked by default to protect the reports, workflows and integrations that depend on them. Even while locked you can still set each template’s assignment group (who can access it) and category (how it is grouped in lists and reports). To change the fields themselves a template can be unlocked – coordinate with PlainSail Support first, as unlocking affects how future platform updates merge.

Full detail in the Inventories guide For the template designer, field types, visibility rules and how to launch inventories against entities, see the Inventories & Configuration guide.

6. Country risk table

Country setup stores each country’s identity, tax-reporting flag, currency, accounting deadline, and country-risk data – corruption perception index, risk scores, overall risk, sanctions, and the reasons behind them. The risk scores recorded here feed the risk rating thresholds in the next section, which is how each country’s risk is applied when assessing the risk of your entities. PlainSail ships with the full standard ISO country list; you can add further countries if you need them.

Where to find it

  • Menu path: Admin > Global Information > Countries
  • Navigation address: admin/countries

Fields and controls

FieldWhat to enterRequiredNotes
Iso CodeThe 2-letter country code.YesMax 2 characters.
Iso 3 CodeThe 3-letter country code.YesMax 3 characters.
NameThe country name.YesMax 100 characters.
Risk fieldsCorruption Perception Index, Risk Score, Other Risk Score, Overall Risk, reasons, Has sanctions, and Sanction description.NoSaved directly against the country.
CurrencyThe country’s currency.NoChosen from all currencies.
Accounting deadline monthsThe accounting deadline in months.No0–12.
In use? / Tax ReportableWhether the country is active and whether it is tax reportable.No
The list includes inactive countries The country list shows inactive countries as well as active ones, so you can re-activate or edit any country.

7. Risk rating thresholds

Risk ratings translate a numeric risk score into a named rating. Each rating has a name, a threshold, and an in-use flag. When scoring, PlainSail orders ratings by descending threshold and uses the first whose threshold is at or below the score.

Where to find it

  • Menu path: Admin > Global Information > Risks
  • Navigation address: admin/riskratings

Fields and controls

FieldWhat to doRequiredNotes
Show in use only?Filters the list to active ratings.On by default.
Name *The rating name.YesMust be unique. Max 100 characters.
Threshold *The numeric threshold for matching.YesCannot be negative.
Is In Use?Whether the rating is available for use.No
Deleting a rating Deleting tries a physical delete first; if the rating has already been used it is marked not in use instead. Deletion is restricted to administrators.

8. Screening integration

Screening runs external background checks and ongoing monitoring of your entities through third-party providers. If your firm screens through PlainSail, confirm the integration is enabled and configured as part of onboarding.

Where to find it

  • Menu path: Global Info > Screening

PlainSail supports LSEG World-Check and RiskScreen for automated (API) screening, plus a Manual File option where automated screening is not available. Administrators click Configure Screening API to enter the provider credentials (your World-Check or RiskScreen API details). Viewing screening needs the Screening_View role; configuring it needs Screening_Administer.

Work with your provider Provider accounts and API credentials are issued by LSEG or RiskScreen. Have these ready, and involve your PlainSail implementation contact to switch screening into API mode.
Full detail in the Global Information guide For the screening list, filters, provider comparison and how cases are processed, see the Global Information guide.

9. Chart of accounts & account plans

The chart of accounts is maintained as ledgers. Each ledger has a code, a name, the ledger it totals to, currency/entity constraints, an account type, a ledger type, and reconciliation flags. Account plans are named sets of non-totalling ledgers.

During onboarding, review PlainSail’s standard chart against your existing one: confirm the account structure fits, identify any gaps, and map your current ledgers across so balances and reporting line up. Add or amend ledgers and account plans as needed before you start posting.

Full detail in the Accounting guide For creating ledgers, account types and working with the chart day to day, see the Accounting & Bookkeeping guide.

Where to find it

  • Menu path: Bookkeeping > Chart of Accounts (with Account Plans and Account Types alongside)
  • Navigation addresses: bookkeeping/ledgersview and bookkeeping/accountplans

Chart of accounts (ledgers)

Field / actionBehaviour
CodeRequired and greater than 0; must be unique and lower than its totalling ledger. Used ledgers cannot change code. Totalling codes conventionally end in 99 (you are warned otherwise).
NameRequired and unique. Totalling ledger names conventionally contain “total” (you are warned otherwise).
Type / Account type / SubledgerMust be compatible with each other. Totalling ledgers use the undefined account type; investment ledgers use an investment subledger and cannot carry a currency or FX revalue.
Totals to / Closes toTotals to is required. Closes to needs both credit and debit, cannot point at a totalling ledger, and warns on currency mismatches.
Delete ledgerBlocked if other ledgers total or close to it. If unused it is deleted; if used it is marked inactive.

Account plans

Field / actionBehaviour
NameRequired and unique.
Is In Use?Controls whether the plan can be used. Deleting a used plan marks it not in use instead.
Account listMust include at least one non-totalling ledger – totalling ledgers cannot be added.
Add a new ledger to a planAfter creating a ledger you are prompted to add it to account plans.
Permissions Viewing the chart of accounts needs Bookkeeping_ChartOfAccounts_View; editing and deleting need the matching _Edit and _Delete roles; account plans need Bookkeeping_ChartOfAccounts_AccountPlans_ViewEditDelete.

10. Fee types

Fee types categorise the charges you raise and control how work in progress is posted to the general ledger. Set these up before your rates, because activity rates are priced against fee types used for time recording.

Where to find it

  • Menu path: Billing > Fee Setup > Fee Types

Each fee type has a categoryFlat Fee, Disbursement, Time Record, or Deposit – which determines the configuration fields shown and how the charge behaves. Time Record fee types are the ones that become chargeable activities in Section 11.

Full detail in the Billing guide For charging entities, entity billing preferences and the full fee-type configuration, see the Billing & Invoicing – Initial Setup guide.

11. Activity rates

Activity rates set the price for a chargeable activity, optionally scoped by client and charging entity, with optional per-user overrides. The activity must be a fee type used for time recording.

Where to find it

  • Menu path: Billing / Time Setup > Activity Rates
  • Navigation address: billing/rates/activityrates

Fields and controls

FieldWhat to doNotes
FiltersFilter by Activity, Client, Charging Entity, and “Show in use only?”.“Show in use only” is on by default.
ActivitySelect the activity to price.Required – if there are no valid activities, add/edit is blocked.
Client / Charging entityOptional scoping.Leave blank for a generic rate that applies to any client/entity.
RateThe rate for the activity.Optional and not negative. A blank rate with no client/entity/override falls back to the user’s default rate band (you are warned).
OverridesPer-user rate overrides.Need a saved activity rate first; each user appears once and rates cannot be negative.
Permissions and duplicates This screen needs the Billing_TimeSetup role. Duplicate activity / client / charging combinations are rejected, and deleting a used rate marks it inactive rather than removing it.

12. Charge-out rates

Charge-out rates are built from staff rate bands (each containing one or more sub-bands with a rate) and a per-user rate band assignment. New users are given the default staff rate band automatically, so a default band must exist before you add people (it is on the pre-setup checklist). Define your full set of bands and allocate them to users as one of the last parts of your user setup.

Where to find it

  • Menu path: Billing / Time Setup > Rate Bands and Staff Rate Bands
  • Navigation addresses: billing/rates/ratebands and billing/rates/staffrates

Rate bands and sub-bands

FieldWhat to doNotes
Band NameName the rate band.Required and unique.
Sub-band NameName each sub-band within the band.Required and unique within the band.
Unit Rate / Hourly RateEnter the rate. “Enter hourly” converts an hourly figure into the stored unit rate.
Default?Marks the default sub-band.Exactly one sub-band must be the default; the first one you add is set as default.
Apply retrospectivelyOptionally apply rate changes from a chosen date.Updates uninvoiced time records from that date. The date must be today or earlier.

Assigning rate bands to users

ControlWhat it doesNotes
Staff rate listShows users and their current rate band.Only lists users who can sign in.
Filter by bandFilters the list by rate band.
ChangeSets a new staff rate band for a user.
Apply retrospectivelyMaps old sub-bands to new ones and updates the user’s uninvoiced records.Without this, only future time records use the new band.
Permissions Both the Rate Bands and Staff Rate Bands screens need the Billing_TimeSetup role. Deleting a rate band that is in use marks it inactive instead of removing it.

13. Invoice templates & billing emails

Finally, set up how invoices are produced and issued. Each charging entity – the legal entity that invoices are raised from – carries the templates and numbering that control the look of your invoices and statements.

Where to find it

  • Menu path: Billing > Fee Setup > Charging Entities

Against each charging entity you set the invoice template (a Word .docx defining the invoice layout), the client statement template, the invoice number pattern, and the default tax band. Entity billing preferences then link each billed entity to a charging entity, including the invoice currency and payment method.

If you issue outgoing invoices to clients by email, confirm the automated billing emails are switched on and addressed correctly before go-live. The exact email setup is environment-specific – agree it with your PlainSail implementation contact.

Full detail in the Billing guide For invoice templates, statements, numbering and day-to-day invoicing, see the Billing & Invoicing guide.

Tips & Warnings

Good to know

  • Work through the stages in order – later areas reuse the user groups, users, and rate bands created earlier.
  • A user is also a business entity. Creating a user creates an entity record you can open from the edit form.
  • New users automatically receive the system currency and the default staff rate band, so make sure both exist before adding people.
  • Most reference data (countries, risk ratings, ledgers, rate bands, activity rates) is never truly deleted once it has been used – it is marked not in use instead, preserving history.

Things to watch out for

  • A new user with no entity permissions sees nothing. After creating a user, add them to an inclusion entity-permission group or they will not see any entities.
  • Exclusion always beats inclusion. If a user is in both an included and excluded permission group for the same entity, the entity stays hidden.
  • Licence limits can block sign-in. If the licensed user count is reached, you cannot save a new user (or switch an existing one) with Can logon? ticked.
  • Existing weekly hours are read-only on the user form. Change them from Time Setup > Working Hours instead.
  • Retrospective rate changes touch live data. Applying a rate band or staff-rate change retrospectively updates uninvoiced time records from the chosen date.
  • You cannot delete yourself or the system user, and the Administrators group and its roles are protected.

FAQ

What order should I configure things in?

Define your user groups and entity permissions first, then create users and slot them in. Next set up workspaces and your standard inventories & registers, then the risk and compliance data: country risk tablerisk rating thresholdsscreening integration. Finish with the finance foundations (chart of accounts and fee types) and time & billing (activity rates, charge-out rates, and invoice templates & billing emails). The numbered sections above follow this order.

Can I assign a role directly to a user?

No. Roles are always assigned to user groups. Create a group with the role you need and add the user to it – the user inherits the role through membership.

I created a user but they can’t see any entities. Why?

Entity visibility comes from entity permission groups, not from the user record. Add the user to an inclusion group that contains the entities they need (Section 2).

A new user can’t sign in. What should I check?

Confirm their Windows name matches their actual login (DOMAIN\username), that Can logon? is ticked, and that the licence limit has not been reached.

How are charge-out rates actually structured?

Through three pieces: staff rate bands (each containing one or more sub-bands with a rate), and a per-user rate band assignment. New users get the default staff rate band automatically; you change an individual’s band from Staff Rate Bands.

What is the difference between an activity rate and a charge-out rate?

An activity rate sets the price for a specific chargeable activity (optionally per client or charging entity, with per-user overrides). A charge-out rate is the user’s default rate, driven by their staff rate band. If no activity rate matches, billing falls back to the user’s rate band.

Why can’t I edit or delete the system user?

It is a protected internal account – it cannot be edited, deleted, impersonated, or removed from the Administrators group.

What happens when I delete reference data that is already in use?

For countries, risk ratings, ledgers, rate bands and activity rates, PlainSail first tries a physical delete. If the record is referenced elsewhere it is marked not in use instead, so existing records keep working.

Project plan checklist

A high-level plan you can copy into your own project tracker and tick off as you go. The order follows the five setup stages above.

DoneStageTaskSection
People & accessCreate the user groups your firm needs and assign roles to each1. User groups
People & accessSet up entity permission groups so users can see the right entities2. Entity permissions
People & accessAdd your users and place each into the right groups and permissions3. User setup
Documents & dataCreate the workspaces used for document filing4. Workspaces
Documents & dataReview and configure the standard inventories & registers5. Inventories & registers
Risk & complianceCheck the country risk table and add any missing countries6. Country risk table
Risk & complianceSet your risk rating thresholds7. Risk rating thresholds
Risk & complianceEnable and configure your screening integration8. Screening integration
Finance foundationsReview, map and adjust the chart of accounts9. Chart of accounts
Finance foundationsSet up your fee types10. Fee types
Time & billingDefine activity rates for chargeable activities11. Activity rates
Time & billingCreate staff rate bands and allocate them to users12. Charge-out rates
Time & billingConfigure invoice templates and confirm automated billing emails13. Invoice templates & emails
Related guides