Versions Compared

Key

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

...

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.

...