deployment

project-build-environment grammar version 44

Switch document

Platform version 2026.2
Component	Version	Languages
Platform components
model	108	application client_request
interface	20	interface
project-build-environment	44	deployment project_wiring
System types
auto-webclient	zora.1	generator_annotations generator_settings parameters phrases query translations
connector	39	processor template variables
datastore	119.2	consumed_interfaces_mapping provided_interface_implementation
relational-database-bridge	111	database database_transformation regular_expression_engine
sql-mirror	119.2	sql_mapping
webclient	zora.1.0	client bindings default features gui_model handheld features main parameters phrases production features query settings translations views widget

Deployment

In order to run an Alan application it needs to be deployed by an Alan Application Server. A deployment.alan file contains instructions for the deployment, such as the source of the initial data and configuration.

Application Servers

The application-servers section lists all the Application Servers needed for the deployment. The Application Server performing the deployment can be referenced with the keyword local.

'application servers': [ application-servers ] dictionary {
	'type': [ : ] stategroup (
		'remote' {
			'socket': component 'tcp socket'
		}
		'host' { [ local ] }
	)
}

External Systems

The wiring.alan file declares which external sources your applications require. In the deployment.alan, you need to provide the exact location of these sources. For specifying a source location, you can use

a TCP/IP address describing where the source excepts connections, or
a path on an Alan Application Server, consisting of an application-servers name, a stack name and a provided-connections name, taken from the wiring.alan of the other stack.

'external systems': [ external-systems ] dictionary {
	'mapping type': [ = ] stategroup (
		'multiple' {
			'targets': [ (, ) ] dictionary { [ [ ]
				'server': [ ] = ] reference
				'stack': [ / ] text
				'route': [ / ] text
			}
		}
		'single' {
			'server': reference
			'stack': [ / ] text
			'route': [ / ] text
		}
		'none' { [ none ] }
		'direct' {
			'socket': component 'tcp socket'
		}
	)
}

Systems

The systems section provides deployment specific information for each system mentioned in a wiring.alan file. Depending on the System Type, a system may require additional configuration, instance data, or a schedule.

Configuration

For systems requiring additional configuration, you can either

use a template from a list of templates for the System Type, and override specific options, or
use a custom configuration, where all options are set by the deployment.

Instance Data

Some systems require data to function (instance data). To provide data for a system, you can either

use the keyword local for the local file system, or
use the keyword from followed by the name of an Application Server, to download the most recent version of the instance data from another stack.

At deploy time, transformations can be applied to your instance data. A transformation can be

a migration, transforming data conforming to an older model to instance data conforming to a new model, or
a conversion from a list of predefined conversions for the System Type.

Schedule

Some systems require a schedule to perform tasks at specific moments in time.

'systems': [ systems ] dictionary {
	'configuration': [ configuration: ] group {
		'base': stategroup (
			'template' {
				'template': reference
			}
			'custom' { [ custom ] }
		)
		'options': dictionary {
			'value': [ = ] component 'value switch'
		}
	}
	'instance data': stategroup (
		'yes' { [ instance-data: ]
			'source': stategroup (
				'local' { [ local ] }
				'remote' { [ from ]
					'server': reference
					'stack name': [ / ] text
					'system name': [ / ] text
				}
			)
			'transformations': group { // TODO: dynamic-order
				'migrate': stategroup (
					'yes' { [ @migrate ] }
					'no' { }
				)
				'convert': stategroup (
					'yes' { [ @conversion: ]
						'conversion': reference
					}
					'no' { }
				)
			}
		}
		'no' { }
	)
	'schedule': stategroup (
		'yes' { [ schedule: ]
			'schedule': component 'schedule'
		}
		'no' { }
	)
}

Component rules

'tcp socket' {
	'host': text
	'port': integer
}

'value' {
	'data type': stategroup (
		'choice' {
			'type': stategroup (
				'multiple' {
					'choices': [ [, ] ] dictionary { }
				}
				'single' {
					'choice': reference
				}
			)
		}
		'number' {
			'value': integer
		}
		'text' {
			'value': text
		}
	)
}

'value switch' {
	'type': stategroup (
		'singular' {
			'is set': stategroup (
				'yes' {
					'value': component 'value'
				}
				'no' { [ none ] }
			)
		}
		'plural' {
			'values': [ (, ) ] dictionary {
				'value': [ = ] component 'value'
			}
		}
	)
}

'schedule' {
	'trigger': stategroup (
		'every day' { [ every day ]
			'trigger': stategroup (
				'every hour' { [ every hour ]
					'every': component 'minute list'
				}
				'select hours' {
					'every': component 'hour list'
				}
			)
		}
		'select days' { [ every ]
			'sunday': stategroup (
				'yes' {
					'day': [ Sunday ] component 'day'
				}
				'no' { }
			)
			'monday': stategroup (
				'yes' {
					'day': [ Monday ] component 'day'
				}
				'no' { }
			)
			'tuesday': stategroup (
				'yes' {
					'day': [ Tuesday ] component 'day'
				}
				'no' { }
			)
			'wednesday': stategroup (
				'yes' {
					'day': [ Wednesday ] component 'day'
				}
				'no' { }
			)
			'thursday': stategroup (
				'yes' {
					'day': [ Thursday ] component 'day'
				}
				'no' { }
			)
			'friday': stategroup (
				'yes' {
					'day': [ Friday ] component 'day'
				}
				'no' { }
			)
			'saturday': stategroup (
				'yes' {
					'day': [ Saturday ] component 'day'
				}
				'no' { }
			)
		}
		'never' { [ never ] }
	)
}

'day' {
	'every': component 'hour list'
}

'hour list' {
	'at hour': [ at ] integer
	'at minute': [ : ] integer
	'has tail': stategroup (
		'yes' {
			'tail': component 'hour list'
		}
		'no' { }
	)
}

'minute list' {
	'at minute': [ at ] integer
	'has tail': stategroup (
		'yes' {
			'tail': component 'minute list'
		}
		'no' { }
	)
}