module.web

Web 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
keycloakConfiguration	The configuration of the Keycloak used for authentication
	KeycloakConfiguration
loggingConfiguration	The configuration of module’s logging
	default	moduleLogLevel	INFO
		externalLogLevel	WARN
	LoggingConfigurationEntity
webSocketMaximumBinaryMessageSize	The WebSocket maximum bytes size of a binary message that can be received.
	type	integer
	minimum	0
	default	65536
webSocketMaximumTextMessageSize	The WebSocket maximum bytes size of a text message that can be received.
	type	integer
	minimum	0
	default	65536
webSocketMaximumFrameSize	The WebSocket maximum bytes payload size of any WebSocket frame that can be received.
	type	integer
	minimum	0
	default	65536
webSocketDefaultInputBufferSize	The WebSocket default input buffer bytes size used to read from network/transport layer.
	type	integer
	minimum	0
	default	4096
webSocketDefaultOutputBufferSize	The WebSocket default output buffer bytes size used to write to the network/transport layer.
	type	integer
	minimum	0
	default	4096
tokenExpirationMarginMs	Token expiration margin in milliseconds. This allows to add margin for token re-validation.
	type	integer
	minimum	0
	default	5000
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	0
		unit	SECONDS
	DurationConfigurationEntity
valueWebsocketSettingsTtlFrequencyChecksTtl	The frequency at which to check for value elapsing. 0 value disable value elapsing.
	default	value	0
		unit	SECONDS
	DurationConfigurationEntity
dashboardResultLimit	Limit dashboard result to front-end. Send how many are matching dashboards but restrict actual results. 0 value disable limitations
	type	integer
	minimum	0
	default	100
mapBoxAccessToken	Mapbox uses access tokens to associate API requests with your account.
	type	string
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.
	type	array
	default
	items	type	string
		enum	flat, folders, tree
dashboardDefaultSearchBehaviour	Default selected behaviour for dashboard search in front-end. Default value must be allowed by dashboardDisabledSearchBehaviours setting.
	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’.
	type	string
	enum	none, folders, tags
	default	folders
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

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
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

DurationConfigurationEntity

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