variables
connector grammar version 36.5
model | 105 | application |
---|---|---|
interface | 20 | interface |
auto-webclient | xindi.1 | generator_settings |
generator_annotations | ||
phrases | ||
query | ||
translations | ||
parameters | ||
connector | 36.5 | processor |
variables | ||
datastore | 113 | consumed_interfaces_mapping |
provided_interface_implementation | ||
migration_mapping | ||
regular_expression_engine | ||
relational-database-bridge | 109 | database |
database_transformation | ||
sql-mirror | 109.1 | sql_mapping |
webclient | xindi.1.1 | views |
widget | ||
client bindings | ||
gui_model | ||
phrases | ||
translations | ||
settings | ||
parameters | ||
project-build-environment | 41 | wiring |
deployment |
Instance Data
Every connector
has a variables.alan
file where a set of key value-type pairs is specified.
The connector requires a values.json
instance data file, this provides the value (of the correct type) for each of these keys.
The values.json
file is required and must also be provided when no keys are specified.
During deployments the runtime validates the provided values and fails when either:
- a value is missing
- a value is of the wrong type
- a superfluous value is present
To help with ensuring a correct values.json
file before deployments, the values-helper
tool is provided.
This can be run from any project with the follow command:
./.alan/devenv/system-types/connector/scripts/generate_values.sh <Path-To-System> <Path-To-Deployment>
Example: ./.alan/devenv/system-types/connector/scripts/generate_values.sh systems/currency-importer ./deployment/demo
The tool is interactive and always prompts the user before deleting any data from an existing values.json
.
Once a new version of values.json
has been written, which is guaranteed to be accepted by the server, the following message is printed:
Values successfully updated
Variables
The variables.
Each has a type of integer
or text
.
The values of each variable is specified in the deployment, see Instance Data.
'variables': dictionary { [ var ]
'type': [ : ] stategroup (
'integer' { [ integer ] }
'text' { [ text ] }
)
}