module.web

Web module

type	object
properties
collectionsRightsEntity	Default selected group by method when search behaviour is not set as ‘flat’. Either group dashboards by their ‘folders’ or their ‘tags’.
	CollectionsRightsEntity
dashboardDefaultSearchBehaviour	Default selected behaviour for dashboard search in front-end. Default value must be allowed by dashboardDisabledSearchBehaviours setting. Default value is [“flat”]
	type	string
	enum	flat, folders, tree
	default	flat
dashboardDefaultSearchGroupBy	Default selected group by method when search behaviour is not set as ‘flat’. Either group dashboards by their ‘folders’ or their ‘tags’. Default value is [“folders”]
	type	string
	enum	none, folders, tags
	default	folders
dashboardDisabledSearchBehaviours	List of disabled behaviours for dashboard search in front-end. Currently available behaviours are: flat -> Display directly every dashboard matching the search, folders -> display the dashboard by using theirs folders representation (described for each dashboard in dashboard.web file). If empty, allows everything. Default value is [[]]
	type	array
	default
	items	type	string
		enum	flat, folders, tree
dashboardResultLimit	Limit dashboard result to front-end. Send how many are matching dashboards but restrict actual results. 0 value disable limitations Default value is [100]
	type	integer
	minimum	0
	default	100
experimentalFeatures	These experimental features are not yet stable and may change at any time. If you are using them, we would appreciate any feedback. Once a feature is considered stable, it will either be moved to another configuration parameter or enabled permanently. Default value is [{“enableHotReload”:false}]
	default	enableHotReload	False
	ExperimentalFeatures
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
keycloakConfiguration	The configuration of the Keycloak used for authentication
	KeycloakConfiguration
loggingConfiguration	The configuration of module’s logging Default value is [{“externalLogLevel”:”WARN”,”moduleLogLevel”:”INFO”}]
	default	externalLogLevel	WARN
		moduleLogLevel	INFO
	LoggingConfigurationEntity
mapBoxAccessToken	Mapbox uses access tokens to associate API requests with your account.
	type	string
messagingConfiguration	The configuration of the Rabbit MQ used for communication
	MessagingConfigurationEntity
startupValueErrorTimeout	The delay during which the error are not published when the module is starting or the value configuration has changed. When a value without an error is publish the delay will be remove immediately. The following errors will not be delayed. This also concern the uninitialized value. During this period, any republish request will generate an uninitialized value. This can be override on the value configuration. Default value is [{“unit”:”MINUTES”,”value”:1}]
	default	unit	MINUTES
		value	1
	DurationConfigurationEntity
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
tokenExpirationMarginMs	Token expiration margin in milliseconds. This allows to add margin for token re-validation. Default value is [5000]
	type	integer
	minimum	0
	default	5000
valueWebsocketSettingsTtlFrequencyChecksTtl	The frequency at which to check for value elapsing. 0 value disable value elapsing. Default value is [{“unit”:”SECONDS”,”value”:0}]
	default	unit	SECONDS
		value	0
	DurationConfigurationEntity
valueWebsocketSettingsValueTtl	How long (time to live - TTL) a value is kept on value WebSocket. When front-end has no longer need for a value (reference count equals 0), it will unregister it after TTL. This enables front-end resources management with still keeping value subscription across navigation. 0 value disable value elapsing. Default value is [{“unit”:”SECONDS”,”value”:0}]
	default	unit	SECONDS
		value	0
	DurationConfigurationEntity
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
webSocketDefaultInputBufferSize	The WebSocket default input buffer bytes size used to read from network/transport layer. Default value is [8192]
	type	integer
	minimum	0
	default	8192
webSocketDefaultOutputBufferSize	The WebSocket default output buffer bytes size used to write to the network/transport layer. Default value is [8192]
	type	integer
	minimum	0
	default	8192
webSocketMaximumFrameSize	The WebSocket maximum bytes payload size of any WebSocket frame that can be received. Default value is [32768]
	type	integer
	minimum	0
	default	32768
webSocketMaximumMessageSize	The WebSocket maximum bytes size of a binary message that can be received. Default value is [262144]
	type	integer
	minimum	0
	default	262144
websocketForceTextMessage	By default the websocket communication is done in binary content, to enable text content (only for debug purpose) set this option to true. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

CollectionsRightsEntity

type	object
properties
enableCollectionRightsRetriever	Whether to enable collection rights retriever. See collection documentation regarding the collection rights configuration ↗️. Default value is [false]
	type	boolean
	default	False
retryDelay	Retry delay when an error occur to retrieve collection rights Default value is [{“unit”:”SECONDS”,”value”:5}]
	default	unit	SECONDS
		value	5
	DurationConfigurationEntity
timeout	Timeout to retrieve collection rights Default value is [{“unit”:”SECONDS”,”value”:5}]
	default	unit	SECONDS
		value	5
	DurationConfigurationEntity
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

ExperimentalFeatures

type	object
properties
enableHotReload	Flag to enable/disable the hot-reload on the module. The modules capabilities ↗️ describe which module support it. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

KeycloakConfiguration

type	object
properties
keycloakHostname	The hostname of keycloak (can be the SWARM id or and IP)
	type	string
realm	The realm of Keycloak
	type	string
additionalProperties	False

LoggingConfigurationEntity

type	object
properties
externalLogLevel	The log level for external libraries logging Default value is [“WARN”]
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR, DISABLE
	default	WARN
moduleLogLevel	The log level for module’s behavior logging Default value is [“INFO”]
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR, DISABLE
	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, DISABLE
additionalProperties	False

MessagingConfigurationEntity

type	object
properties
bufferSize	The size of the buffer to use when the broker is disconnected (default: 60000). Default value is [60000]
	type	integer
	minimum	1
	default	60000
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
storeMessagesOnDisk	Flag to indicate to store the message (The path /osp/messages must be mount to a volume). Default value is [false]
	type	boolean
	default	False
additionalProperties	False