Configuration packages

Configuration packages are a way to configure Agile Data Engine. They are committed and deployed in the same way as entity packages. They also enable sharing configurations between projects.

Configuration packages can be divided into three categories:

Base configurations
Project defaults
Solution development

Usage

Configuration packages are exported in JSON format, edited, and then imported back to the Designer. In this same way they can be shared between projects and Agile Data Engine accounts (SaaS) or installations (Private).

Tutorials

See the below video for a quick tutorial of configuration packages.

https://youtu.be/kzNPJtPRN88

Notes

Some configuration packages need to be committed and deployed into Runtime environments (see tables below).

Some configuration packages can be changed with Designer user interface (see tables below).

Configuration packages are described with the #System tag which makes them easier to find in the package list.

Categories

Base configurations

Configuration package	Description	Runtime deployment needed
CONFIG_DATATYPES	Configure datatype mappings from source system DBMS to logical datatypes used in Agile Data Engine. Affects entity import.	No
CONFIG_ISSUE_TRACK_SYSTEM	Configure Designer to create links into an issue tracking system out of issue/ticket IDs used in description and commit message fields.	No
CONFIG_BASE	Undocumented	No

Project defaults

Configuration package	Description	Runtime deployment needed
CONFIG_AUTOCOMPLETIONS	Define keywords and code snippets to customize Code Editor’s autocompletions	No
CONFIG_ENTITY_DEFAULTS	Define per entity type which attributes and attribute names etc. are by default created when a new entity is created. Also supports default physical options and keys.	Yes
CONFIG_ENTITY_PERMISSIONS	Define target database permissions/privileges and roles/groups that can be used in entity permissions. Also define per entity type which permissions are granted by default when a new entity is created.	Yes
CONFIG_LOAD_TRANSFORMATIONS	Customize the default attribute transformations of Agile Data Engine. Introduce more transformations to automate and unify development work.	Yes
CONFIG_LOAD_TEMPLATES	Manage load logic templates created and used in Designer. CONFIG_LOAD_TEMPLATES enables deleting and mass editing load logic templates and also sharing and importing them between projects.	No
CONFIG_VALIDATIONS	Define validations for an entity package. Currently supports commit message format validation at the package commit phase.	No

Solution development

Configuration package	Description	Runtime deployment needed
CONFIG_ENVIRONMENT_VARIABLES	Define environment (e.g. Dev, Test, UAT, Production) specific variables. For example, set environment specific cron expressions for load schedules, define environment specific target database roles/groups etc.	Yes
CONFIG_LOAD_SCHEDULES	Define workflow/DAG schedules, which are selectable in entity load definitions. Based on these schedule definitions (and entity load mappings) the workflows/DAGs are generated into Workflow Orchestration. Configuration view is the preferred way of editing the package contents.	Yes
CONFIG_SYSTEMS	Define Source Systems, which are selectable in SOURCE entity definition. These source systems are referred in Notify API calls when new files to be loaded are published. Configuration view is the preferred way of editing the package contents.	Yes