Core concepts
The terms Virtik uses and how they relate: organisation, site, member, role, site access, incident, detection, Digital Twin, plan and entitlement, and audit.
- Version
- 0.2
- Last updated
Browse documentation
- What is Virtik?
- Quick startNot published yet
- Core concepts
- Requirements
- Deployment checklistNot published yet
These are the words the rest of the documentation relies on. They are defined here once, in the sense the product uses them.
People and access
- Organisation
- The account an organisation holds in Virtik. Everything the organisation records belongs to it, and the product is built to keep one organisation's records apart from another's; the Tenant isolation document states what is and is not covered. Also called the tenant.
- Member
- A person who belongs to an organisation. A member is invited, becomes active when they accept, and can be suspended and restored.
- Role
- What a member is allowed to change: administrator, editor or viewer. Members can see most of the organisation's records, subject to site access; some administrative records are for administrators only. Editors can also operate, and administrators can also manage the organisation. See Roles.
- Operational role
- A label an organisation defines for the work a person does, such as a patrol officer or supervisor. It is used across the product. It also grants operational capabilities, such as patrol access, where an organisation has configured them; it does not change the member's role.
- Team
- A grouping of members that an organisation defines.
- Site access
- Permission to work with the records of one site. Administrators have it for every site; editors and viewers receive it per site, or through a team bound to the site. A direct assignment can expire; team access does not.
- Two-step verification
- A second proof, from an authenticator app, required for administrators and editors, and for some sensitive administrative actions (the Multi-factor authentication document lists them).
Places and models
- Site
- A place the organisation operates. Cameras, incidents, personnel presence and the Digital Twin all attach to a site.
- Virtual Site
- The module where a site is modelled. Also used for the model itself.
- Digital Twin
- A navigable model of a site, built from 360° scenes and plans. A site has one active twin, and a published version is the site's operational model.
- Zone
- An area of a site's plan. A camera placed in a twin reports the zone, level and building it covers.
Events and work
- Detection event
- Something a camera's analysis reports. An event has a severity and a review state, and is reviewed by a person.
- Review state
- Candidate, Review required, Confirmed, Dismissed or Escalated.
- Incident
- A situation being worked. It has a status (Open, Acknowledged, Active, Resolved or Closed), a severity, a site and a timeline. Closed is final.
- Dispatch
- The record of a responder's progress on an incident, from Assigned to Released.
- Alert
- A message sent to people about an incident. The channels offered are in-app, push and SMS; push is not delivered in this release.
- Drill
- A rehearsal incident. It cannot send SMS or push alerts.
Plans and limits
- Plan
- What an organisation's commercial agreement includes, such as how many sites and members it may have.
- Entitlement
- The part of a plan that switches a capability on. For features that depend on a plan, a capability has to be both included in the plan and permitted by the person's role. The application checks this and, for some capabilities, the database does too.
- Capability
- A named feature, such as Analytics or the Digital Twin Studio, that a plan can include or leave out.
Records and review
- Audit entry
- A record that something was done, by whom and when. Some are written by the system and some by the screens.
- Review edition
- A document that is complete but not yet approved for publication.
- Availability
- How far what a document describes has been verified: Verified in controlled testing, Partially available, or Not yet verified. A module that does not exist yet is marked Roadmap — not yet available.
Current availability
Related
- What is Virtik?
- Roles
- Permissions
- Your first site