# Glossary

## Purpose
Plain definitions of the words you meet in the Assessor.io interface, in the order you
tend to meet them. Where the interface uses more than one word for the same thing, the
preferred term is the heading and the alternatives are noted underneath.

## Scope
Product terms: things you can point at in the app.

---

## Product terms

### account
Your workspace. Everything else (campaigns, templates, members, labels, reports)
belongs to exactly one account, and nothing crosses between accounts. The account id
is the first segment of every signed-in URL (`/<accountId>/dashboard/...`).

Also called **workspace** in the interface: the sidebar header reads "Workspace". The
campaign screen's way back is **Back to account dashboard**. An account is not the
same thing as a participant's *organisation*, which is the employer on that person's
record.

### member
A person who can sign in to an account and work in it: an administrator, a campaign
manager, an auditor, a viewer. Members are managed under **Team & Access**. A member is
not the same thing as a participant: members operate the account, participants answer
assessments in it.

### role
A named bundle of permissions ("Account Manager", "Campaign Manager", "Campaign
Auditor") that you grant to a member. Roles are granted at a **scope** (the whole
account, one campaign, one assessment, or one participant), so the same person can be
an auditor on one campaign and nothing at all on another. Roles live under **Team &
Access → Member roles**; the **Roles & Policies** item in the sidebar opens that tab
directly. System roles are locked: you copy one with **Duplicate role** rather than edit
it.

### policy
The building block a role is made of: a set of individual permitted actions. Roles
attach policies; members are granted roles. You only need policies if the shipped roles
do not fit (see **Team & Access → Policies**).

### campaign
A single round of assessment: who is being assessed, over what period, using which
assessments. A campaign holds participants, assessments, auditor assignments, files,
communications, reports and its own activity log. Campaign status is **Draft**,
**Active** or **Inactive**.

Two separate settings decide how people meet it:

- **Private** or **Public** decides how the campaign presents itself. A public campaign
  gets the **Public Campaigns Page** settings and can be listed (see *listing*). It does
  not decide who may answer.
- **Who may answer** decides who gets in: **Anyone with the link**, a **Passcode**, or
  **Invitation only**. A private campaign with a passcode still accepts walk-ups: anyone
  who knows the passcode can answer, without an account.

### assessment
One deployment of a template inside a campaign: the thing a participant actually
opens and fills in. The campaign screen also calls these **deployments**: its list of
them is headed **Active deployments**. An assessment has its own name, status
(**Draft** / **Active** / **Completed**), and, once published, a public link.
Publishing an assessment is what opens it for responses.

### template
The reusable question set an assessment is built from: its pages, questions and answer
options, held as a SurveyJS schema. Templates live under **Assessments** (the page is
titled "Assessment templates"). A **global** template is supplied by the platform and is
read-only in your account; a **local** template belongs to your account and can be
edited, locked, cloned, exported and replaced.

Note the vocabulary collision: the sidebar item **Assessments** opens the *template
library*, while an *assessment* is the deployment inside a campaign.

### public deployment key
The short code in an assessment's public URL (`/a/<KEY>`), and what you hand to
participants. One is generated for you; you can set your own, of 4 to 20 capital
letters, numbers, `-` or `_`. Shown as "Public key / link" in the deployments table and
"Public Deployment Key" in the assessment's settings.

### statement
An action statement: a single, reusable piece of assessable content that can be bound
into templates and translated independently of any one template. Many are mirrored from
the **BIMei Ontology**; an account can also hold its own, local statements. Statements
are what the **Translations → Statements** workbench translates.

### statement set
A named collection of statements distributed to accounts as a group, so a curated body
of content can be published and versioned in one move rather than statement by
statement. In your account, distributed sets are read-only; you can also make local
ones. Both are under **Knowledge Base**.

### BIMei Ontology
The shared vocabulary of the BIMei tools, at ontology.bimexcellence.org. It holds
action statements as canonical or candidate entries, and Assessor.io mirrors them
read-only, so the same statement means the same thing in every account. Shortened to
**ONT** in some screens and guides.

### Blueprint
A brief, such as a project information requirements document, being turned into an
assessment template. Started from **New from a brief** under **Assessments**. Nothing
in a blueprint reaches a participant until a template is compiled from it and
published.

### participant
A person being assessed in a campaign. Participants are listed on a campaign's
**Participants & Roles** tab. A participant has a status (**Invited**, **Active**,
**Suspended** or **Completed**) and may have auditors assigned to them.

A participant does not have to be a member: someone can answer a public assessment link
without ever signing in.

### submission
One participant's answers to one assessment. A submission is either still a **draft**
(in progress, autosaved) or completed. Completed submissions are what feed counts,
scorecards and exports; drafts are deliberately excluded from scoring.

### draft
An in-progress submission. The public assessment page autosaves answers as the
participant works and shows a "Draft saved" pill; returning to the same link in the same
browser restores them. A draft is tied to the browser it was started in, not to a
sign-in.

### auditor
A member assigned to review particular participants or assessments. Auditors work in
the **Auditor Workspace**, where they see only their own assignments. "Supervisor" is
the wording used on the participants bulk bar ("Assign Supervisor"), and it grants the
same kind of scoped assignment.

### review
An auditor's verdict on one answer inside one submission: a verification status
(**unverified**, **verified**, **modified**), an optional corrected answer, an optional
note, hashtags, and two switches: include it in exports, and share it with the
participant. Reviews are per answer, not per submission.

### assessee
The participant on the receiving end of a review. The term appears in feedback-sharing
contexts to distinguish "the person being reviewed" from "the person reviewing".

### scorecard
A computed result set for a campaign, produced by running a **report definition** over
the campaign's completed submissions. Scorecards are rendered as KPI cards, bar, line,
pie, heatmap or table, and are cached: the page marks each one **Cached** or **Freshly
computed**.

### report definition
The recipe behind a scorecard: its scope (account, campaign, assessment or participant),
its report type, its aggregation rules, and its default chart. Global built-in
definitions are read-only: use **Clone to account** to change one. Account
definitions are yours to create, edit and delete.

### registration form
A public application form bound to a campaign. Applicants open it at
`/register/<formId>`, answer it, and their answers arrive as a **registration
submission** for review. Forms carry switches for who can reach them (**Anyone with
the link can open the form**, **People can apply without signing in**, **Can be shown
inside other websites**) and for the triage assistant (**The triage assistant may review
applications**).

### registration submission
One application to a registration form. It has a decision state: **Pending**
(stored as "Unverified"), **Accepted**, **Declined**, or one of two holds,
**Waitlisted** and human review (**Needs review**; an action runs on it **When held for
review**). It also has
reviewer notes, and an audit trail of who decided and when.

### registration action
An "if this outcome, then do that" rule attached to a registration form: add the
applicant to a campaign, attach members to them, add labels, or send a message. Actions
are bound to the Accepted, Declined or Hold-like branch and run when a decision is
recorded.

### label
A short reusable tag with a name and a short **Code**, used to classify assessments,
participants and members. Labels are grouped into **label groups**; each label and group
is either **global** (supplied by the platform) or **local** (yours). Managed under
**Labels** in the sidebar.

### label group
A named set of labels, with a description and a **Used for:** line saying what its
labels may be put on: statements, assessments, users, templates, participants or
reviews. A **global** group is read-only in your account. A **local** group is yours to
rename, lock and delete; unlock it before you add labels to it or delete it.

### contact
A person in the account's lightweight CRM: a lead captured from a contact form or
registration, added by hand, or pushed across from a campaign's participant list.
Contacts move through the stages **new → contacted → qualified → converted → lost** and
can be converted into a campaign participant.

### activity log
The account's audit trail: who did what to which record and when, plus the notification
events the system queued. Reachable at **Activity Logs**, and exportable as CSV.

### published results
A campaign's completed results exposed at a public, read-only link (`/results/<key>`)
with no sign-in. You choose whether to include per-participant answers, and whether to
anonymise the people behind them.

### join passcode
An account-level shared secret. Anyone signed in who goes to `/join` and enters the
account's **join key** (its slug) plus this passcode joins the account as a
participant. Distinct from a *campaign passcode*, which gates one campaign.

### campaign passcode
A shared secret for ONE campaign whose **Who may answer** is **Passcode**, set in the
campaign's **Campaign Admin** settings. It opens two doors, and they are not the same
door: signed in, it joins you to the campaign (`/auth/entry?campaign=…`); typed on the
campaign's own public page, it lets you **answer without an account** at all. A response
filed that way is anonymous (the passcode says that somebody knows a shared secret and
says nothing about who they are), so only an invitation and its personal link produce an
identified response. An entry lasts twelve hours on the browser it was typed in.
Distinct from a *join passcode*, which is account-level.

### campaign code
A campaign's short name, the same word that ends its public address
(`/public/campaign/<code>`). Typed into the invitation-code field on the Assessor.io
home page (*If you have an invitation, enter the code:*), it opens the campaign's public
page, or its sign-in page when the campaign needs a passcode or an invitation. Not a
secret: it appears in links and on posters.

### listing
A campaign shown on the Assessor.io home page, under **Open now to all**, and on the
list of open campaigns at `/public/campaigns`. Organisers switch it on with **List on
assessor.io** and may add **Who it's for**, a one-line audience shown on the card. A
listed campaign shows only while it is public, active and open. Listing advertises a
campaign; it does not change who may answer.

### programme
An ordered series of an account's campaigns, such as the waves of a study that runs for
several years. Its one public address, `/p/<key>`, sends visitors to its current
campaign: the open one, else the next to open, else the one that closed most recently.
Once a campaign in a programme has closed, its public page names the next one under
**What's next**. A campaign belongs to one programme at most. A programme can also have a
page of its own at that address, in English and French, which it shows once it is no
longer a draft. For now the Assessor.io team sets programmes up.

## Related Pages
- [Account administrator home](/operate/tenant-admin/tenant-admin-home)
- [Participant home](/use/participants/participant-home)
