module.maps¶

Maps 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
mongoDbConfigurationEntity	The configuration of the Mongo Database
	MongoConfigurationEntity
propertiesIndexes	The indexes on the properties. Defining indexes let you optimize the database queries, they provide a way to quickly locate documents without scanning the entire collection. But Not every field needs an index, they should be used on fields that are frequently queried, as they consume extra storage and can affect write performance.
	type	array
	items	IndexConfigurationEntity
additionalProperties	False

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

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

type	object
properties
serverUrl	The hostname of the mongodb configuration. (For example: mongodb://<host-1>,…,<host-x>/?replicaSet=<replSet-id>)
	type	string
databaseName	The name of the database to use
	type	string
	default	alarms
additionalProperties	False

type	object
properties
name	The name of the index
	type	string
index	The Mongo expression used for indexing. See https://docs.mongodb.com/manual/indexes/ for more information.
sparse	Create the indexes only the document when the field exist
	type	boolean
	default	False
partialFilterExpression	Partial filter expression used to filter the elements that are affected by this index
additionalProperties	False