module.rights

Rights module

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • messagingConfiguration

The configuration of the Rabbit MQ used for communication

MessagingConfigurationEntity

  • loggingConfiguration

The configuration of module’s logging

default

moduleLogLevel

INFO

externalLogLevel

WARN

LoggingConfigurationEntity

  • groups

The access configuration for the element in the configuration

type

array

items

GroupConfigurationEntity

additionalProperties

False

MessagingConfigurationEntity

type

object

properties

  • clientId

The ID of the client, must be different for each module instance.

type

string

  • host

The host of the rabbit MQ provider

type

string

  • bufferSize

The size of the buffer to use when the broker is disconnected (default: 60000).

type

integer

minimum

1

default

60000

  • storeMessagesOnDisk

Flag to indicate to store the message (The path /osp/messages must be mount to a volume).

type

boolean

default

False

additionalProperties

False

LoggingConfigurationEntity

type

object

properties

  • moduleLogLevel

The log level for module’s behavior logging

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

default

INFO

  • scriptLogLevel

The log level for module’s internal script behavior logging (if not set the moduleLogLevel will be used)

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

  • externalLogLevel

The log level for external libraries logging

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

default

WARN

additionalProperties

False

GroupConfigurationEntity

type

object

properties

  • name

Name of the group

type

string

  • description

  • externalLink

Link to the external group (LDAP, Radius, …)

type

array

items

type

string

  • markdownDescription

additionalProperties

False