Settings
The following settings for sections are general valid, no matter what view type is used.
Name |
|
---|---|
name | Used source - see Sources |
caption | Friendly name of the section. |
group | If you define this value in multiple sections, you can group several sections into one menu group. |
type | What view type should a section support.
The different types can be stacked. One section can have multiple views. If the passed value is an array, the user will be able to switch between the different views in the UI. Example: - name: customers
caption: Kunden
type:
- list
- map |
description | Description, which is shown on top of each section in the UI |
role |
If you don’t define it, role Admin only sections will be displayed in the administration view. |
formId | Use an existing form to provide an “add” feature in this section. Forms are highly flexible and support multiple types of fields and validations. Refer to: Forms |
formLabel | The caption of the “add” feature for the defined form. |
columns | This is defines which columns are shown in the section and how they should behave. You can define the data types, the label and if they should be shown in the summary or in the detail-view. Refer to: Column Types Example: columns:
- label: 'Kommission'
key: 'SalesOrderCommission'
- label: 'Prod.-Auftrag'
key: 'ProductionOrderNumber'
type: 'number'
showInTableHeader: false
showInDetailList: true
|
sortField | on what field should the sorting be applied. By default, this is A user can always overwrite the sorting by clicking on the column header of a list. |
sortOrder |
|
hidden | Whether the section should be hidden from the sidebar |
disableExport | Disables the PDF export (only shown for the organigram view). |
disableCsvExport | Disables the CSV export |
disableFavorite | Disables the favorite (add to dashboard) button for the whole section. |
disableFiles | Hides the preview of files in the detail view of an entry. Useful in conjunction with publicMode and using your html to render the files. |
disableNotifications | Disables the notification trigger for the whole section. |