Page Comparison

...

• 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.

/

...

data

In case there are data objects (JSON documents), typically based on a schema, they should be stored inside this path structure:

global/app/tld.domain.myapp/data/form/create-user
<NAME>/<UUID>

Whereas <NAME> is the name of the data object.

<UUID> is the unique id of a single data object.

For example:

global/app/tld.domain.myapp/data/form/delete-user

See here for more details: Forms Framework

/function

This optional folder contains all Python FaaS functions which will be automatically deployed when such a property of this app is stored in the property store in this folder.

For more information see: Python Functions

/i18n

This optional folder contains all internationalization (i18n) files like message files and other resources.
Also see: Internationalization (i18n).

/install

This optional folder can also contain pipeline YAML scripts. These pipelines will be executed only in case the app will be installed using the app.install or app.update command.

This is handy in case you would like to do some preparation on the install or update phase of an app like migrations for example.

The pipelines will be executed in their natural naming order. So if you would like to make sure a pipeline gets executed the very first, make sure it is at the very top of the naming order by using prefixes like 001-, 002- and so on.

/list​

This optional folder contains all list configuration properties for any list of the app, whereas the name of the property is the name of the list. For example:

global/app/tld.domain.myapp/list/all-users
global/app/tld.domain.myapp/list/all-employees

See here for more details: List Framework

/object​

This optional folder contains any application model (schema) and its instances (if there are any).

/schema​

...

person/fa471958-fdb7-4bf6-a0a3-c5e8c782893e

Each instance property will contain as value the data of the object instance which typically matches the schema, for example:

{
  "firstName": "Homer",
  "lastName": "Simpson",
  "age": 48,
  "gender": "male"
}

/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:

global/app/tld.domain.myapp/form/create-user
global/app/tld.domain.myapp/form/delete-user

See here for more details: Forms Framework

/function

This optional folder contains all Python FaaS functions which will be automatically deployed when such a property of this app is stored in the property store in this folder.

For more information see: Python Functions

/i18n

This optional folder contains all internationalization (i18n) files like message files and other resources.
Also see: Internationalization (i18n).

/install

This optional folder can also contain pipeline YAML scripts. These pipelines will be executed only in case the app will be installed using the app.install or app.update command.

This is handy in case you would like to do some preparation on the install or update phase of an app like migrations for example.

The pipelines will be executed in their natural naming order. So if you would like to make sure a pipeline gets executed the very first, make sure it is at the very top of the naming order by using prefixes like 001-, 002- and so on.

/list​

This optional folder contains all list configuration properties for any list of the app, whereas the name of the property is the name of the list. For example:

global/app/tld.domain.myapp/object/<NAME>/<VERSION>/schema

Whereas <NAME> is the name of the object.

<VERSION> is the version of the object schema.

For example:

object/person/v1/schema

The schema property typically contains as value a JSON schema, which describes this object. For the person object, the schema could, for example, look like this:

{
  "type": "object",

  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "type": "number"
    },
    "gender": {
      "type": "string",
      "enum": ["male", "female", "neutral"]
    }
  }
}

See the JSON schema section for more details: JSON Schema

/instance​

...

list/all-users
global/app/tld.domain.myapp/list/all-employees

See here for more details: List Framework

/object​ (deprecated)

This optional folder contains any application model (schema) and its instances (if there are any).

/schema​ (deprecated)

The schema of an object is stored in a property having this path:

global/app/tld.domain.myapp/object/<NAME>/<VERSION>/schema

Whereas <NAME> is the name of the object.

<VERSION> is the version of the object schema.

For example:

object/person/v1/schema

The schema property typically contains as value a JSON schema, which describes this object. For the person object, the schema could, for example, look like this:

{
  "type": "object",

  "properties": {
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "age": {
      "type": "number"
    },
    "gender": {
      "type": "string",
      "enum": ["male", "female", "neutral"]
    }
  }
}

See the JSON schema section for more details: JSON Schema

/instance​ (deprecated)

In case there are object instances (JSON documents) based on a schema, they should be typically stored inside this path structure:

global/app/tld.domain.myapp/object/<NAME>/<VERSION>/instance/<UUID>

Whereas <NAME> is the name of the object.

<VERSION> is the version of the object schema.

<UUID> is the unique id of a single object.

For example:

global/app/tld.domain.myapp/object/person/v1/instance/fa471958-fdb7-4bf6-a0a3-c5e8c782893e

Each instance property will contain as value the data of the object instance which matches the object schema, for example:

{
  "firstName": "Homer",
  "lastName": "Simpson",
  "age": 48,
  "gender": "male"
}

/pipeline​

This optional folder contains all persisted pipeline YAML scripts for the given app. A pipeline can be seen as the business logic or data integration part of an application.

Each property name corresponds with the name of the pipeline and contains as value the pipeline YAML script.

Examples:

global/app/tld.domain.myapp/pipeline/001-send-invite-email
global/app/tld.domain.myapp/pipeline/add-to-sap
global/app/tld.domain.myapp/pipeline/inform-hr

Such a pipeline YAML script could look like this:

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

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

/report

This optional folder can contain all report configurations.

See here for more details: Reporting Framework

/resource

This optional folder can contain any resource required inside the app. For example images, CSS files or similar.

/schema

The schema of an data object is stored in a property having this path:

global/app/tld.domain.myapp/objectschema/<NAME>/<VERSION>/instance/<UUID>

Whereas <NAME> is the name of the object.

<VERSION> is the version of the object schema.

<UUID> is the unique id of a single object.

data object this schema stands for.

For example:

global/app/tld.domain.myapp/objectschema/person/v1/instance/fa471958-fdb7-4bf6-a0a3-c5e8c782893e

...

The schema property typically contains as value a JSON schema, which describes this object. For the person object, the schema could, for example, look like this:

{
  "firstNametype": "Homerobject",

  "lastNameproperties": {
    "Simpson",
  "age": 48,firstName": {
      "type": "string"
    },
    "gender": "male"
}

/pipeline​

This optional folder contains all persisted pipeline YAML scripts for the given app. A pipeline can be seen as the business logic or data integration part of an application.

Each property name corresponds with the name of the pipeline and contains as value the pipeline YAML script.

Examples:

global/app/tld.domain.myapp/pipeline/001-send-invite-email
global/app/tld.domain.myapp/pipeline/add-to-sap
global/app/tld.domain.myapp/pipeline/inform-hr

Such a pipeline YAML script could look like this:

pipeline:
  - mail.send:
      to: hr@company.delastName": {
      "type": "string"
    },
    "age": {
      "type": "number"
    },
    "gender": {
      subject"type": "A new employee was addded!"

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

/report

This optional folder can contain all report configurations.

See here for more details: Reporting Framework

/resource

...

string",
      "enum": ["male", "female", "neutral"]
    }
  }
}

See the JSON schema section for more details: JSON Schema

/setup​ (deprecated)

...