Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This optional folder contains all app specific configuration properties.

The default configuration property in here is the config property which is a JSON document.

...

for an app is the app property. This is automatically created if you create an app via CLI or the online property wizard. It is a JSON document of this basic format:

Code Block
languagejson
{
  "title": "My App",
  "description": "The description of the app",
  "icon": "some_icon_id",
  "color": "teal-8",
  "hidden": false,
  "tags": [
    "admin"
  ],
  "permissions": {
    "read": [
      "CAN_APP_io.pipeforce.myapp",
      "ROLE_ADMIN",
      "ROLE_DEVELOPER"
    ],
    "write": [
      "CAN_APP_io.pipeforce.myapp",
      "ROLE_ADMIN",
      "ROLE_DEVELOPER"
    ],
    "view": [
      "CAN_APP_io.pipeforce.myapp",
      "ROLE_ADMIN",
      "ROLE_DEVELOPER"
    ]
  }
}
  • title = The short title of the app. Can optionally be a $uri:i18n key for translations.

  • description = The description of the app. Can optionally be a $uri:i18n key for translations. Can be empty.

  • icon = The id of the Google Material icon to be used for this app. See here for listing of all available icons: https://fonts.google.com/icons . Note: Make sure to use the id of the icon not its name. If no icon is set, the system default icon will be used.

  • color: The color to be used for the app icon. If not set, the default color will be used. Also see here: Colors for more details about supported color codes.

  • hidden: An optional flag. If true, the app wont be shown in the apps listing in the portal. The default value is false.

  • tags: A list of optional search keywords. This improves finding this app via UI search.

  • permissions: Defines the required permissions for this app.

    • read = A list of ROLES, the logged-in user must be member of (at least in one of it) to be able to read values in this app (for example list properties / data stored in this app).

    • write = A list of ROLES, the logged-in user must be member of (at least in one of it) to be able to write values in this app (for example properties / data to the property store, submit forms).

    • view = A list of ROLES, the logged-in user must be member of (at least in one of it) to be able to see the app tiles, forms and lists in the web UI.

/form

This optional folder contains all form configurations for any form of the app, whereas the name of the property is the name of the form. For example:

...

Code Block
languageyaml
pipeline:
  - mail.send:
      to: hr@company.de
      subject: "A new employee was addded!"

Also see Command and Data Pipeline for more details how to create persisted pipelines.

...

See here for more details: App Testing

/uninstall

Status
colourBlue
titleSInce Version 9.0

...