Flow Manifest
Each Flow contains a file called the manifest (manifest.json). This file contains information which allows the Flow to be started and to specify the configuration in which the Flow runs.
An example of a manifest is shown below:
{
"main": [
"my_flow",
"fi-0"
],
"signals": {
"main": {
"entry": [
"my_flow",
"fi-0"
],
"args": [
"arg0"
]
}
},
"arguments": {
"arg0": {
"type": "int32",
"default": 12345,
"description": "My cool argument"
}
},
"resources": [
{
"path": "std_nodes.js",
"provider": "js",
"runtime": "",
"options": []
},
{
"path": "std_nodes.json",
"provider": "visualscript",
"runtime": "",
"options": []
},
{
"path": "my_flow.graph",
"provider": "visualscript",
"runtime": "",
"options": []
}
]
}
The main section defines the main entry-point of the flow, with the forward in port to call to start running the flow.
In the future, the main section will be deprecated in favor of the signals section (see below). But until this happens, the signal section is only required if you need to pass arguments to a JavaScript entry point.
The signals section defines a list of entry-points of the flow. Each of those specifies a forward in port to call and positional arguments for the backward in port. The signal with name "main" is the main entry-point (i.e. override the main section).
The arguments section declares global arguments for the flow. Those can be passed directly to the entry-point in the signals section, set in service call when starting the flow, and accessed at runtime within the flow.
The resources section defines all the files used by the flow and which provider and runtime to be used to run that resource.
Agent version 1.6.14 or higher is required to support "signals" and "arguments".
The web platform does not support signals for now. Until it does, you'll need to make sure that "main" is equal to "signals"."main"."entry".