Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 10 Next »

Sections are also called sometimes “views” and is the last cornerstone for using Portrait. Sections define:

  • How the data will be represented

  • Who will see the section

  • If a form for capturing data is needed

  • How the search should behave

The section is a pure presentation layer. No data is stored in it.

Settings

Name

 

name String

Used source.
Refer to ELO sources or SQL sources.

caption String

Friendly name of the section.

group String

if you define this value in multiple sections, you can group several sections into one menu group.

type String

list (default) = show entries as list / table

map = show entries on an interactive map

orgchart = show entries as interactive organizational chart

timeline = show entries as timeline

description String

Description, which is shown on top of each section in the UI

role String

ADMIN = only admins can see this section

USER = every user can see this data

If you don’t define it, role USER will be applied.

formId String

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 String

The caption of the “add” feature for the defined form.

columns
List<object>

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: 'Auftrag'
  key: 'SalesOrderNumber'
  type: 'number'
  showInTableHeader: true
  showInDetailList: true
- label: 'Prod.-Auftrag'
  key: 'ProductionOrderNumber'
  type: 'number'
  showInTableHeader: false
  showInDetailList: true

 

sortField

on what field should the sorting be applied. By default, this is name. This sorting is always applied when the user opens a list the first time. This is especially useful, if you want to sort by date or priority.

A user can always overwrite the sorting by clicking on the column header of a list.

sortOrder

asc = (default) list the entries in ascending order (A to Z)

desc = list the entries in descending order (Z to A)

  • No labels