Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Application Roles

  • Article
  • 2 minutes to read
Role Type Privilege Level Description
Activities Template Manager Security User This role grants the rights to manage activities templates.
Authorised Guest Security Guest This role grants the rights to guest users that have been authenticated.
Contacts Admin Security User This role grants the rights to add, edit and delete contacts as well as customise portals.
Coworker Lifecycle Security User This role grants the rights to design and use the lifecycle button on the coworkers page
Data Imports Administrator Security User This role grants the rights to manage Data Imports
Form Designer Security User This role grants the rights to design existing forms including adding additional fields as well as changing the default layouts.
HAi Agent Assistant Security User This role grants the rights to use HAi Agent Assistant and HAi User Assistant if enabled
HAi Agent Initializer Elevation User This is an elevation role that grants rights for HAi User Assistant.
HAi Insights Security Basic This role grants the rights to use HAi Insights sidebar
HAi User Assistant Security Basic This role grants the rights to use HAi User Assistant
Home Page Manager Security User This role grants the rights to manage the Home Page
Locations Manager Security User This role grants the rights to manage Locations
Organisations Admin Security User This role grants the rights to add, edit and delete organisations.
Simple List Management Elevation User This is an elevation role that grants rights to manage simple lists.
Sites Manager Security User This role grants the rights to manage Sites
System Initializer Elevation User This elevated role should only ever be used for the FlowCode elevation, initial data setup and configuration.
Translator Security User This role grants the rights to define translations for application strings between different languages.
User Administrator Elevation User This is an elevation role that grants rights to administer Core User, Contact and Organisation entities.
User Import Security User This role should only be used for User Import Tool.
webRTC signalling Elevation User This role is an elevated role used when starting a webRTC chat
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document