menu.web

Front-end menu definition

type	object
properties
description	The menu description
	type	string
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
menus	Menu configuration
	type	array
	items	Menu item definition
moduleId	The ids of the modules that will have access to this menu.
	type	array
	items	type	string
name	The menu name
	type	string
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
additionalProperties	False

Menu item definition

type	object
properties
context	Menu context which allows to interact based on widget type
	type	array
	items	MenuContextConfiguration
icon	Icon displayed in front of the menu label (https://material-ui.com/components/material-icons/) with naming in snake_case.)
	type	string
label	Menu label shown to user
	type	string
subMenu	Sub-menu attached to menu item
	type	array
	items	Menu item definition
additionalProperties	False

MenuContextConfiguration

type	object
properties
action	Menu action reference
	type	string
blockFrontInteractionWhileExecuting	Whether to block all interaction with the front-end while the action is being executed or not. This is done by displaying a progress component in the foreground. Default value is [false]
	type	boolean
	default	False
closeAfterInteraction	Whether to close menu after interaction or not Default value is [true]
	type	boolean
	default	True
condition	Menu action condition
	type	string
input	Menu context input
	type	object
	additionalProperties	anyOf	type	string
			type	object
			properties
			expression	type	string
			as	Mapping data method example from a input extract from a collection. “extract”: “rows.clicked.summary”, “as”: “string” Learn more about input dynamic data extraction️ ↗️
				type	string
				enum	timestamp, object, boolean, string, integer, number, decimal
			extract	type	string
			prompt	type	object
				properties
				type	type	string
					enum	GROUPS, SEVERITY, INPUT, COMBO, DATE, DATE_TIME, TIME, FORM, ATTACHMENTS
				additionalProperties	True
			additionalProperties	False
			type	boolean
			type	number
			type	integer
output	Menu context output
	type	array
	items
outputExecution	Are menu context outputs executed in order (SYNC) or in parallel (ASYNC, default) Default value is [“Concurrent”]
	type	string
	enum	Sequential, Concurrent
	default	Concurrent
scopes	Menu action scope. If empty, menu is shown everywhere.
	type	array
	items	type	string
		enum	Toolbar, Click
type	Menu context type
	oneOf	type	string
		enum	AlarmTable, AlarmHistoryTable, AlarmSeverity, AnalyticsAggregate, BasicInputOutputValue, BasicText, BorderLayout, BoxLayout, Chart, CollectionTable, Discovery, Form, FormList, Gauge, Geo, Icon, Json, Limit, Journal, Maps, Markdown, Media, MenuAction, Navigation, ObjectBrowser, PdfViewer, Range, Refresh, ReportsList, ReportsViewer, Schematic, Select, Text, Toolbar, Value, ValueSubscription, VideoPlayer, PtzController, WebView, *
		type	array
		items	type	string
			enum	AlarmTable, AlarmHistoryTable, AlarmSeverity, AnalyticsAggregate, BasicInputOutputValue, BasicText, BorderLayout, BoxLayout, Chart, CollectionTable, Discovery, Form, FormList, Gauge, Geo, Icon, Json, Limit, Journal, Maps, Markdown, Media, MenuAction, Navigation, ObjectBrowser, PdfViewer, Range, Refresh, ReportsList, ReportsViewer, Schematic, Select, Text, Toolbar, Value, ValueSubscription, VideoPlayer, PtzController, WebView
		uniqueItems	True
additionalProperties	False