...

If this attribute is missing, "hidden": false is used as a default.

permissions

This optional attribute defines who By default any logged-in user can see the form inside an app. If this attribute is missing, all users can see this form. Example:

...

...

the form using role based access rules (RBAC):

• RBAC-A: Is member of ROLE_DEVELOPER or

• RBAC-B: Is member of CAN_APP_<app.name> of the according app and ROLE_USER.

This is the default in case no permissions attribute is defined in the app config. This default can be overwritten by specifying the permissions attribute in the form config. In this case the RBAC-B will be ignored. Instead RBAC-C applies:

• RBAC-C: User is member of CAN_APP_<app.name> and at least one of the given permission rules is valid.

Example:

{
  ...
  "permissions": {
    "read": ["ROLE_DEVELOPERGUEST"]
  }
}

The attribute read defines a list of permission strings the currently logged-in user must match at least one of. By default such a permission string is the name of a required role. In this example, the user must be any logged-in user assigned to ROLE_DEVELOPER in order GUEST and CAN_APP_<app.name> is able to see this form inside the app.Furthermore also PIPEFORCE . In case the user is assigned to ROLE_DEVELOPER he can also see this form since this will always apply.

PIPEFORCE URIs as permissions

Furthermore, also PIPEFORCE URI prefixes are supported to define permissions such as:

...

:

...

• $uri:group:<groupname> = Logged-in user must be member of group with name <groupname>.

• $uri:role:<rolename> = Logged-in user must have assigned this role (this is used by default also if no such prefix is used.)

schema

The schema attribute defines Example:

{
  ...
  "permissions": {
    "read": ["ROLE_DEVELOPER", "$uri:group:supervisors"]
  }
}

schema

The schema attribute defines a PIPEFORCE URI which is called in order to retrieve the Form schema for this form.

...

The output defines the path in the property store where the form data must be stored as JSON property after the form has been submitted. Example:

input"output": "$uri:property:global/app/tld.domain.myapp/objectdata/person/v1/instance/"

Since path ends in a slash / the form framework identifies this as a new property creation and automatically appends the uuid of the new property as “filename” at the end of the path (since version 10). In versions < 10, you had to add the PE ${vars.property.uuid}

...

The PE variable at the end. This PE will be interpreted on the server side and replaced by the UUID of the property. The form handling This approach is deprecated and will be removed soon.

The form handling pipeline can listen to a property.created event on this path then in order to get informed when a new property was created on this path:

pipeline:
  - event.listen:
      eventKey: property.created
      filter: ${body.target.path.contains('/tld.domain.myapp/objectdata/person/v1/instance/')}

The same way it works with property.updated event.

...

"input": "$uri:property:global/app/tld.domain.myapp/objectdata/person/v1/instance/fe97df"

Which could return a form data (= model) as JSON to be edited similar to this:

...

In horizontal orientation, layout items and fields, by default, attempt to use maximum width while considering neighboring fields, making them responsive.

Both min-width and max-width can be also used in place of width to reach responsiveness within defined limits.

Nesting layouts and orientations​

Layouts and its orientations can be nested in order to create quite complex form structures. Here’s an example-width can be also used in place of width to reach responsiveness within defined limits.

Nesting layouts and orientations​

Layouts and its orientations can be nested in order to create quite complex form structures. Here’s an example:

{
  "title": "Person Form",
  "description": "A simple person form.",  
  ...
  
  "layout": {
    "orientation": "horizontal",
    "items": [
      {
        "orientation": "vertical",
        "items": [
          {"field": "firstName"},
          {"field": "age"}
        ]
      },
      {
        "orientation": "vertical",
        "items": [
          {"field": "lastName"},
          {"field": "gender"}
        ]
      }
    ]
  } 
}

This example would produce a form with nested orientations like the one shown below:

...

field

Inside a layout element you can place field elements pointing to field ids (widgets). This element can contain additional attributes like these:

hidden

If set to true, the widget is not shown in the form, but the value from the input is sent to the backend on submit. Example:

      ...
      {
  "title      "orientation": "vertical",
        "items": [
          {"field": "Person Formage",   "descriptionhidden": "A simple person form.",true}
        ]
...      "layout": {},
     "orientation": "horizontal",
 ...

readonly

If set to true, the widget value cannot be changed. Example:

    "items": [  ...
      {
        "orientation": "vertical",
        "items": [
          {"field": "firstNameage"}, "readonly": true}
        {"field": "age"}]
      },
  ]    ...

height

Sets the height of this field, overwriting the default value in case the widget supports this attribute.

Example:

      },...
      {
        "orientation": "vertical",
        "items": [
          {"field": "lastNamefirstName"},
          {"field"height": "gender"20}
        ]
      },
    ]
  } 
}

This example would produce a form with nested orientations like the one shown below:

...

field

Inside a layout element you can place field elements pointing to field ids (widgets). This element can contain additional attributes like these:

hidden

...

  ...

width

Sets the width of this field, overwriting the default value in case the widget supports this attribute.

Example:

      ...
      {
        "orientation": "vertical",
        "items": [
          {"field": "agefirstName", "hiddenwidth": true30}
        ]
      },
      ...

readonly

...

color

In case this field is a multi-file upload, with color, the color of the file chips can be specified.

Example:

      ...
      {
        "orientation": "vertical",
        "items": [
          {"field": "agemyFiles", "readonlycolor": true"blue"}
        ]
      },
      ...

...

Grouping with title and border

...

Internationalization (i18n)

TODOThe title and description of a form and also its validation messages can be internationalized (= translated to different languages). See here for more details, how this works: Internationalization (i18n).

Special Form Types

Document Understand Form (with AI support)

TODO

Variable substitution

...