...
Code Block |
---|
global/app/tld.domain.myapp/pipeline/001-send-invite-email global/app/tld.domain.myapp/pipeline/A1-upload-invoice global/app/tld.domain.myapp/pipeline/add-to-sap global/app/tld.domain.myapp/pipeline/inform-hr |
/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 |
---|
global/app/tld.domain.myapp/form/create-user global/app/tld.domain.myapp/form/delete-user |
/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
Info |
---|
Any time the hub service restarts ( |
...
for example because of rescaling), all function scripts inside this folder will be automatically scanned and re-deployed to the FaaS backend if required. |
/install
Status | ||||
---|---|---|---|---|
|
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
command.
This is handy in case you would like to do some preparation on the install phase of an app.
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.
Info |
---|
The pipelines in this folder wont be auto-executed on save of properties in the portal or on publish using the CLI or on hub restart. Only the initial |
/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:
Code Block |
---|
global/app/tld.domain.myapp/list/all-users global/app/tld.domain.myapp/list/all-employees |
/object
This optional folder contains any application model (schema) and its instances (if there are any).
...
Code Block | ||
---|---|---|
| ||
{ "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.
...
Also see Command and Pipeline for more details how to create persisted pipelines.
Info |
---|
Any time the hub service restarts (for example because of rescaling), all pipeline scripts inside this folder (recursively) will be automatically scanned and any trigger command inside each pipeline will be re-registered (for example jobs, message listeners, …). |
/setup
Note | ||||||
---|---|---|---|---|---|---|
DEPRECATED since
/install folder instead. |
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
command.
...
Info |
---|
The pipelines in this folder wont be auto-executed on save of properties in the portal or on publish using the CLI or on hub restart. Only an the inital |
/script
...
Note | ||||||
---|---|---|---|---|---|---|
DEPRECATED since
/function folder instead |
...
. |
/test
This optional folder typically contains pipelines for tests only. Whenever necessary, PIPEFORCE automatically executes the test pipelines inside this folder to make sure the app is working as expected. Therefore you have to make sure that these tests can be executed at any time and are fully reentrant (once a test has been finished it can be executed again as often as necessary).
...
Code Block |
---|
pipeline: - test: assertTrue(false) |
/uninstall
Status | ||||
---|---|---|---|---|
|
This optional folder can also contain pipeline YAML scripts. These pipelines will be executed only in case the app will be uninstalled using the app.uninstall
command.
This is handy in case you would like to do some preparation before uninstall.
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.
Info |
---|
The pipelines in this folder wont be auto-executed on save of properties in the portal or on publish using the CLI or on hub restart. So triggers in these pipelines wont work. Only a call of |
/update
Status | ||||
---|---|---|---|---|
|
This optional folder can also contain pipeline YAML scripts. These pipelines will be executed only in case the app will be updated using the app.update
command.
This is handy in case you would like to do some update and migration tasks on update.
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.
Info |
---|
The pipelines in this folder wont be auto-executed on save of properties in the portal or on publish using the CLI or on hub restart. So triggers in these pipelines wont work. Only a call of |
/workflow
This optional folder contains any BPMN workflow files defining a business process.
...