Skip to content

Licences

Intro

Licences are used to allow users to access modules, catalogues & catalogue modules within the Flowcode app.

Creating licences

Licences are created in the App management module of the App which is available to admin-level users. When creating a licence the key details are:

  • Name: A helpful name used to identify and find the given licence
  • Description: A helpful description as a record of what that licence is for
  • Inherits: A toggle as to whether the given licence inherits the other licences in the organisation

Linking abilities to the licence

Once a licence has been created you can link abilities to the licence. Currently the abilities are in the following categories:

  • App modules: These are feature modules in the app that can be granted using the licence, eg: Objectives
  • Catalogue modules: These are catalogue modules that can be given access to via the licence, eg: Strategy formulation
  • Single catalogues: These are single catalogues that can be specifically granted using the licence, eg: SSD

Adding licences to an organisation

Once a licence has been created, any combination of licences can be added to the organisations. These licences can be given an expiry date, and also assigned to a user up-front OR left unassigned.

All the organisation's licences are allocated to the organisation, and the allocated user to the licence can be changed by the organisation owner or the app admin.

Licence expiry

Licences can be given an optional expiry date when allocating to an organisation. Once the expiry date has been reached, the licence will no longer give the allocated user's the access.

Licence user's access

Accessing a user's licences

All the methods to determine a user's licence is in methods in the User model:

$user->licenses($organisation)->get()

Accessing a user's App modules

To access a user's app modules you can use the following method:

'$user->appModules($organisation)->get()'

Accessing a user's Catalogue modules

To access a user's catalogue modules you can use the following method:

$user->catalogueModules($organisation)->get()

Accessing a user's Organisation catalogues

To access a user's organisation catalogues, you can use the following method:

$user->organisationCatalogues($organisation)->get()