Layouter
Information about the different layout options.
Data
The data
tag allows to show different variables to the user within a box.
The boy has a headline and can be collapsed to hide information.
Example
<data name="Properties">
<variable ident="ident" />
<variable ident="version" />
<variable ident="status" />
<variable ident="right" access="write" />
<variable name="Static" value="This string will always be shown" />
<variable name="Dynamic" workflow="wf_name" />
</data>
Attributes
- id: The id of this node
- name: The name to display
- status: The stati where the node should be shown
- rights: One of the rights needed to show the node
- edit: Defines the edit state of the node
- style: The which should be applied ot the node
- record: A record Uuid, or filed name with reference to show the data for
- collapsed: Collapse the data panel, to save space
- children: The data children containing the single values
Variable
The variable
tag is only valid within a data
tag and is used to define a single variable within.
Example
<data name="Properties">
<variable ident="ident" />
<variable ident="version" />
<variable ident="status" />
<variable ident="right" access="write" />
<variable name="Static" value="This string will always be shown" />
<variable name="Dynamic" workflow="wf_name" no-edit />
</data>
Attributes
- id: The id of this node
- name: The name to display
- status: The stati where the node should be shown
- rights: One of the rights needed to show the node
- edit: Defines the edit state of the node
- style: The which should be applied ot the node
- ident: The ident of the variable to show
- value: A fixed OOTB value to show
- workflow: A workflow which should be executed an every change
Raw-Html
The raw-html
is used wo show custom html to the user.
Example
<raw-html>
<raw-html>
<h2>Custom Headline</h2>
<p>Custom sentence</p>
</raw-html>
</raw-html>
Record-Logs
The record-logs
tag is used to show the history of records to the user. It's recommended to use this as the only element within a specific tab. Users can add comments to the history to mark specific events.
Example
<tab name="History">
<record-logs />
</tab>
Highlight-Data
The highlight-data
tag allows to show a value to the user within a highlight element. The data can be queried dynamically from the database. THe component acts also as a clickable button element.
Example
<highlight-data
id="data-432"
name="User [amount]"
sql="SELECT count(uuid) FROM user;"
></highlight-data>
Attributes
- id: The id of this node
- name: The name to display under the value
- status: The stati where the node should be shown
- rights: One of the rights needed to show the node
- edit: Defines the edit state of the node
- sql: The sql query to get the data
- value: The default/fallback value
- precision: How many decimal places should be shown
- workflow: Workflow to be executed when clicking the element
- link: A link which should be opened when clicking the elment
- target: The target for the link
Chart
The chart
node is used inside a dom to display a custom chart.
Example
<chart id="chart_123" name="Your Data" typ="doughnut" collapsed>
<chart-data sql="SELECT count(ident) FROM user;" />
</chart>
Attributes
- id: The id of this node
- name: The name to display
- status: The stati where the node should be shown
- rights: One of the rights needed to show the node
- edit: Defines the edit state of the node
- style: The which should be applied ot the node
- typ: The chart visualisaton type either
bar
,pie
ordoughnut
- collapsed: Collapse the chart panel, to save space
- data: The data children containing the single values