view.web

Web alarms view

type	object
properties
expandMultipleRows	Allow multiple rows to be expanded at the same time. If false, when expending a row, every other expanded rows are closed. Default value is [true]
	type	boolean
	default	True
historyColumns	The column to show on the live table
	type	array
	items	oneOf	Attachment render
			String render
			Number render
			Acknowledge render
			Boolean render
			Collection render
			Severity render
			Tags render
			Array count render
			JSON render
			Journal render
			Timestamp render
			Relative time render
			Form render
			URL render
			Image render
			Markdown render
			Journal metadata render
			Operation render
historySort	The column sort settings on the history table Default value is [[]]
	type	array
	default
	items	WebColumnSort
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
liveColumns	The column to show on the live table
	type	array
	items	oneOf	Attachment render
			String render
			Number render
			Acknowledge render
			Boolean render
			Collection render
			Severity render
			Tags render
			Array count render
			JSON render
			Journal render
			Timestamp render
			Relative time render
			Form render
			URL render
			Image render
			Markdown render
			Journal metadata render
			Operation render
liveSort	The column sort settings on the live table Default value is [[]]
	type	array
	default
	items	WebColumnSort
moduleId	The id of the module using this view
	type	string
reorderable	Whether or not columns are reorderable Default value is [true]
	type	boolean
	default	True
tableRowDetail	Type of row to show when expanding an row. Default value is [“detail”]
	type	string
	enum	none, detail, journal
	default	detail
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

Attachment render

type	object
properties
render	type	string
	enum	ATTACHMENT
	default	ATTACHMENT
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Attachment render column options
	AttachmentWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

String filter

type	object
properties
type	type	string
	enum	STRING
	default	STRING
additionalProperties	False

Number filter

type	object
properties
type	type	string
	enum	NUMBER
	default	NUMBER
additionalProperties	False

Boolean filter

type	object
properties
type	type	string
	enum	BOOLEAN
	default	BOOLEAN
options	Boolean filter column options
	BooleanWebColumnOption
additionalProperties	False

BooleanWebColumnOption

type	object
properties
falseIcon	Icon shown when boolean value is false. Defaults to ‘done’.
	type	string
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
strictBoolean	Determine if the value must strictly be a boolean. If set to true and value is not a boolean, like an array for example, the value will be considered as undefined. Default value is [true]
	type	boolean
	default	True
trueIcon	Icon shown when boolean value is true. Defaults to ‘done’.
	type	string
undefinedIcon	Icon shown when boolean value is undefined.
	type	string
additionalProperties	False

WebColumnCollectionFilter

type	object
properties
additionalFields	Fields to search on additionally (using OR predicate). Field can be expressed as field.subfield.name.
	type	array
	items	type	string
additionalProperties	False

List filter

type	object
properties
type	type	string
	enum	LIST
	default	LIST
options	List filter column options
	ListFilterOption
additionalProperties	False

ListFilterOption

type	object
properties
values	List of text values proposed as the filter options.
	type	array
	items	type	string
additionalProperties	False

Collection filter

type	object
properties
type	type	string
	enum	COLLECTION
	default	COLLECTION
options	Collection filter column options
	CollectionWebColumnOption
additionalProperties	False

CollectionWebColumnOption

type	object
properties
dependsOn	DependsOn define a list of filters applied to the query retrieving the content from the collection. The value applied by each of the filters are defined by the value of other columns filters. A dependence is then define by: column: the name of the column from which we retrieve the value of the filter. field: the name of the field from the collection to compare the value with the value of the filter. The goal of this feature is to allow you to make a column filter options more precise each time you add another column filter that should reduce the content you want to retrieve. As an example, take a collection with a provider and a description field. We want this column to display the description of the content of the collection, but we have another column that already filters the content of the table by providers. If we want the options of this column filter to only be those that match the provider defined in the other column filter, we add a dependency to this column as: {column: theOtherColumnName, field: provider}
	type	array
	items	WebColumnCollectionDependsOn
depth	A depth greater than 0 allow to get content from a recursively structured collection. The collection must have a nodes field. As an example, with a Site collection with entries like {someField: "Site-1", nodes: [{someField: "Location-1"}, {someField: "Location-2"}, {someField: "Location-3"}]}, you can use a depth as 1 to retrieve the sub-locations of a site, stored inside the nodes field of the Site collection. Using depth as 1 will give you the result: [{someField: “Location-1”}, {someField: “Location-2”}, {someField: “Location-3”}]. Using a default depth as 0 will give you: [{someField: “Site-1”, nodes: […]}]. Depth must be at least 0 and doesn’t have a maximum boundary. Be aware that having a high depth could affect the queries efficiencies.
	type	integer
	minimum	0
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
format	Subfield to access collection content to search for. Should you provide content as an object, such as {someNameField: objectName, someProperties: property, ...}, you can specify someNameField as format.
	type	string
projection	Projections define a rules to include/remove one or more fields from the result.
	WebColumnCollectionProjection
schemaId	Reference to the schema representing the collection from which we want to retrieve options. The choices available in the column filter are then displayed using the given format or, if not present, using the column name as the default format.
	type	string
search	Define how search in the filter works. Either performs a local search or a remote search.
	WebColumnCollectionSearch
additionalProperties	False

WebColumnCollectionDependsOn

type	object
properties
column	The name of the column from which we retrieve the value of the filter
	type	string
field	The name of the field from the collection to compare the value with the value of the filter
	type	string
additionalProperties	False

WebColumnCollectionProjection

type	object
properties
fields	The name of the fields to include/remove from the result
	type	array
	items	type	string
included	If true, the fields are included on the result. Otherwise, they are removed.
	type	boolean
additionalProperties	False

WebColumnCollectionSearch

type	object
properties
fields	List of fields to search the term on only when the search method is set to remote
	type	array
	items	type	string
method	Method of search: remote: search is built and send with the query to be performed by the collections module. Queries have a limit of results set to 1000. If the target collection has more entries, remote search is the only way to be able to retrieve all of them. local: search is performed locally by the front-end. If the target collection has less than 1000 entries, local search is the recommended method. (Default option)
	type	string
	enum	local, remote
additionalProperties	False

Severity filter

type	object
properties
type	type	string
	enum	SEVERITY
	default	SEVERITY
options	Collection filter column options
	SeverityWebColumnOption
additionalProperties	False

SeverityWebColumnOption

type	object
properties
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
format	Subfield to access severity content to search for. Should you provide severity as an object, such as {someNameField: severityName, severity: severityPriority, ...}, you can specify someNameField as format.
	type	string
isSeverityLockedField	Field to detect locked severity (default to isSeverityLocked when severity field is severity).
	type	string
origSeverityField	Field to detect retrieve origin severity when locked (default to origSeverity when severity field is severity).
	type	string
additionalProperties	False

Timestamp filter

type	object
properties
type	type	string
	enum	TIMESTAMP
	default	TIMESTAMP
options	Timestamp render column options
	TimestampWebColumnOption
additionalProperties	False

TimestampWebColumnOption

type	object
properties
disableTimezoneExport	Whether to disable timezone or not when exporting table content as xls format.
	type	boolean
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
formatter	Date format using dayjs formatting (supports locale formatting). See Day.js formatting manual ↗️ for more information.
	type	string
formatterExport	Date format using dayjs formatting (supports locale formatting) used when table export is used. See Day.js formatting manual ↗️ for more information.
	type	string
additionalProperties	False

AttachmentWebColumnOption

type	object
properties
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
previewBehavior	Behavior when attempting to show preview for a media. Two options are available: SHOW_ALL: when opening the preview for a media, it display with it a slider that allow to visualize all the other media contained in this column. SHOW_ONLY_SELECTED (default): when opening the preview, only display the selected media in the preview. Default value is [“SHOW_ONLY_SELECTED”]
	type	string
	enum	SHOW_ALL, SHOW_ONLY_SELECTED
	default	SHOW_ONLY_SELECTED
previewShowNavigation	Enable/Disable navigation of the elements through the pagination component on the top of the preview window. Default value is [true]
	type	boolean
	default	True
uploadId	Reference to the upload configuration used to upload and retrieve the medias.
	type	string
additionalProperties	False

String render

type	object
properties
render	type	string
	enum	STRING
	default	STRING
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

CommonWebColumnOption

type	object
properties
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
additionalProperties	False

Number render

type	object
properties
render	type	string
	enum	NUMBER
	default	NUMBER
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Acknowledge render

type	object
properties
render	type	string
	enum	ACKNOWLEDGEMENT
	default	ACKNOWLEDGEMENT
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Boolean render column options
	BooleanWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Boolean render

type	object
properties
render	type	string
	enum	BOOLEAN
	default	BOOLEAN
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Boolean render column options
	BooleanWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Collection render

type	object
properties
render	type	string
	enum	COLLECTION
	default	COLLECTION
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Collection render column options
	CollectionWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Severity render

type	object
properties
render	type	string
	enum	SEVERITY
	default	SEVERITY
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Collection render column options
	SeverityWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Tags render

type	object
properties
render	type	string
	enum	TAGS
	default	TAGS
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Array count render

type	object
properties
render	type	string
	enum	ARRAY_COUNT
	default	ARRAY_COUNT
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

JSON render

type	object
properties
render	type	string
	enum	JSON
	default	JSON
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Boolean render column options
	JsonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

JsonWebColumnOption

type	object
properties
display	JSON viewer options.
	JsonWidgetOptionsSettings
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
style	Viewer appearance, as a map of CSS variable name to value, applied on top of the current theme. Values declared at the root of the object apply to both light and dark themes, while values declared under the optional light and dark keys only apply to the matching theme mode and take precedence over the root ones. Supported CSS variables are: Global: --w-rjv-font-family, --w-rjv-color, --w-rjv-background-color. Keys: --w-rjv-key-string, --w-rjv-key-number, --w-rjv-quotes-color, --w-rjv-quotes-string-color. Punctuation and structure: --w-rjv-curlybraces-color, --w-rjv-colon-color, --w-rjv-brackets-color, --w-rjv-line-color, --w-rjv-arrow-color, --w-rjv-ellipsis-color, --w-rjv-info-color, --w-rjv-edit-color, --w-rjv-update-color, --w-rjv-copied-color, --w-rjv-copied-success-color. Value types: --w-rjv-type-string-color, --w-rjv-type-int-color, --w-rjv-type-float-color, --w-rjv-type-bigint-color, --w-rjv-type-boolean-color, --w-rjv-type-date-color, --w-rjv-type-url-color, --w-rjv-type-null-color, --w-rjv-type-nan-color, --w-rjv-type-undefined-color. For example: { "--w-rjv-font-family": "monospace", "light": {"--w-rjv-type-string-color": "#1b5e20"}, "dark": {"--w-rjv-type-string-color": "#81c784"} }
additionalProperties	False

JsonWidgetOptionsSettings

type	object
properties
collapsed	When set to true, all nodes will be collapsed by default. Defaults to false.
	type	boolean
displayDataTypes	When set to true, data type labels prefix values. Defaults to false.
	type	boolean
displayObjectSize	When set to true, objects and arrays are labeled with size. Defaults to false.
	type	boolean
enableClipboard	The user can copy objects and arrays to clipboard by clicking on the clipboard icon. Defaults to true.
	type	boolean
highlightUpdates	Whether to highlight updates. Defaults to true.
	type	boolean
indentWidth	Set the indent-width for nested objects. Defaults to 15.
	type	integer
keyName	Define the root node name of the object. Defaults to empty.
	type	string
objectSortKeys	Whether sort keys alphabetically or not. Defaults to false.
	type	boolean
shortenTextAfterLength	Shorten long JSON strings, set to 0 to disable this feature. Defaults to 30.
	type	integer
additionalProperties	False

Journal render

Journal column rendering. This render allow side panel journal settings.

Only one journal column render must be specified.

type	object
properties
render	type	string
	enum	JOURNAL
	default	JOURNAL
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Journal render column options
	JournalWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

JournalWebColumnOption

type	object
properties
displayWithMultipleRows	Whether to display (true) or not (false) journal side panel when multiple rows are selected/shown.
	type	boolean
editMode	Sets journal entries edition mode. Available values are: all: allow user to update all journal entries self: allow user to only update self journal entries none: disallow user to update journal entries
	type	string
	enum	all, self, none
enabledAddEditEntryExpression	Expression evaluated to check whether to allow user to add/edit journal entry.
	type	string
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
inputMethod	Select which input method is used. Available values are: Message: only allow user to set message TimestampMessage: allow user to set message and timestamp
	type	string
	enum	Message, TimestampMessage
journalSettingsOverride	Journal override settings for insert/edit input, table and timeline view. Settings available are: form: Form to use to insert/update an entry of the journal tableView: View definition (sorts and columns) for the table display timelineTextFormatter: Expression formatter for the content displayed inside the timeline display Currently, only available for CollectionsTable related views.
	JournalSettingsOverride
summaryFormatterExpression	Expression evaluated to show summary in side panel.
	type	string
type	Sets the journal display type used. Available values are: Timeline: show the journal as a chat Table: show the the journal as a table
	type	string
	enum	Timeline, Table
uploadId	Reference to the upload configuration used to upload and retrieve the attachment.
	type	string
usernameAttribute	User preference attribute to show username from. Learn more about user preference ↗️.
	type	string
additionalProperties	False

JournalSettingsOverride

Journal override settings for insert/edit input, table and timeline view.

Settings available are:

• form: Form to use to insert/update an entry of the journal

• tableView: View definition (sorts and columns) for the table display

• timelineTextFormatter: Expression formatter for the content displayed inside the timeline display

Currently, only available for CollectionsTable related views.

type	object
properties
form	Form to use to insert/update an entry of the journal.
	type	string
tableView	View definition (sorts and columns) for the table display.
	JournalSettingsOverrideTableView
timelineTextFormatter	Expression formatter for the content displayed inside the timeline display.
	type	string
additionalProperties	False

JournalSettingsOverrideTableView

Settings for the table view of a journal.

Settings available are:

• sort: The column sort settings

• columns: The columns that can show one of the journal properties

type	object
properties
columns	The columns that can show one of the journal properties
	type	array
	items	oneOf	Attachment render
			String render
			Number render
			Acknowledge render
			Boolean render
			Collection render
			Severity render
			Tags render
			Array count render
			JSON render
			Journal render
			Timestamp render
			Relative time render
			Form render
			URL render
			Image render
			Markdown render
			Journal metadata render
			Operation render
sort	The column sort settings Default value is [[]]
	type	array
	default
	items	WebColumnSort
additionalProperties	False

Timestamp render

Timestamp column rendering. This render take a OnSphere timestamp.

type	object
properties
render	type	string
	enum	TIMESTAMP
	default	TIMESTAMP
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Timestamp render column options
	TimestampWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Relative time render

type	object
properties
render	type	string
	enum	RELATIVE_TIME
	default	RELATIVE_TIME
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Form render

type	object
properties
render	type	string
	enum	FORM
	default	FORM
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

URL render

URL column rendering. This render take an URL or array of URL from row content and displays it as link for the user.

type	object
properties
render	type	string
	enum	URL
	default	URL
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	URL render column options
	UrlWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

UrlWebColumnOption

type	object
properties
filter	When filtering a column, allow to specify additional fields to filter on (using a OR predicate). This only applies to CollectionTable columns. It allows, for example, to filter the date column with additional dates fields.
	WebColumnCollectionFilter
samePage	Whether to open URL in the same page (true) or new tab (false).
	type	boolean
additionalProperties	False

Image render

type	object
properties
render	type	string
	enum	IMG
	default	IMG
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Markdown render

type	object
properties
render	type	string
	enum	MARKDOWN
	default	MARKDOWN
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Journal metadata render

type	object
properties
render	type	string
	enum	JOURNAL_METADATA
	default	JOURNAL_METADATA
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

Operation render

type	object
properties
render	type	string
	enum	OPERATIONS
	default	OPERATIONS
aggregate	Column summary aggregate function.
	type	string
	enum	min, max, count, sum, avg
display	Whether or not column is displayed by default Default value is [true]
	type	boolean
	default	True
field	The field to display on this column
	type	string
filter	Column filter component.
	oneOf	String filter
		Number filter
		Boolean filter
		List filter
		Collection filter
		Severity filter
		Timestamp filter
filterable	Whether or not column is filterable Default value is [true]
	type	boolean
	default	True
maxWidth	Column maximum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is greater than that an error will be generated.
	type	integer
	minimum	0
minWidth	Column minimum width in pixels for the user or the auto fitment. If the Column width is defined as pixels and is lower than that an error will be generated.
	type	integer
	minimum	0
name	The column name
	type	string
options	Default render column options
	CommonWebColumnOption
position	The column position
	type	integer
sortable	Whether or not column is sortable Default value is [true]
	type	boolean
	default	True
width	Column width. Default: “auto”. Unit has to be included with space: [10 px | 20 %] Default value is [“auto”]
	type	string
	pattern	^(auto|(\d+)\s(px)|((100|\d{1,2})\s(\%))|\d+|)$
	default	auto
additionalProperties	False

WebColumnSort

type	object
properties
direction	The column name
	type	string
	enum	asc, desc
field	The column field name
	type	string
additionalProperties	False