Config schema¶

This document describes the schema of the config.json file. The config.json file is used to configure the available views and actions for the web-app.

Root object¶

Name	Type	Description	Required
Sites	array<SiteConfig>	A list of Sites	required
Panels	array<PanelConfig>	A list of Panels	required
Filters	array<FilterConfig>	A list of Filters	required
ContextMenus	array<ContextMenu>	A list of ContextMenus	required
DndMenus	array<DnDMenu>	A list of DndMenus	required
Menus	array<Menu>	A list of Menus	required

SiteConfig¶

Name	Type	Description	Required
Id	integer		required
DisplayName	string	The name that will be displayed to users	required
PanelIds	array<integer>	A Site can display several Panels that are specified here	required
RoleNames		A Site can be shown to only authorized users, which can be described here

RoleNames¶

Name	Type	Description	Required
Values	array<>

PanelConfig¶

Name	Type	Required
Id	integer	required
SearchField	string	required
Columns	array<Column>	required
FilterIds	array<integer>	required
Table	string	required
PermissionTable	string	required
DefaultCondition	null

Column¶

Name	Type	Description	Required
FieldName	string	The name of the property (usually a database column)	required
DisplayName	string	The label that should be displayed in the UI	required

FilterConfig¶

Name	Type	Description	Required
Id	integer	Id must be unique among all filters	required
DisplayName	string	The name that will be displayed in the UI	required
ActionsMenuId	integer	Every filter is bound to a specific ActionMenu	required
RoleNames		A filter can be made available to specific roles. If this property is not set, the filter will be available for all users
Condition	null	An SQL condition that is used as part of a where clause when querying the database table

ContextMenu¶

Name	Type	Description	Required
ItemType	string	TODO	required
MenuId	integer	The id of the corresponding Menu	required

DnDMenu¶

Name	Type	Description	Required
ItemTypes	array<>	A combination (a list) of itemtypes, for which this Drag-and-Drop-Menu will be available	required
MenuId	integer	The id of the corresponding Menu	required

MenuItem¶

Name	Type	Description	Required
DisplayName	string	Will be used in the UI	required
UrlTemplate	string	UrlTemplate is used to create a url at runtime with specified parameters. ++ explanation of parameters ++	required
RoleNames		A MenuItem can be restricted to users that belong to certain Roles