CONFIG_ENVIRONMENT_VARIABLES

CONFIG_ENVIRONMENT_VARIABLES is a configuration package that is used to configure environment specific variables.

See also:

• CONFIG_LOAD_SCHEDULES

Usage

1. Open the configuration package from Designer package list.

2. Click Export package in the Actions tab.

3. Click Download.

4. Edit JSON file.

5. Import edited JSON back to Designer with Import Package.

After a successful import, changes to the configuration package have been applied to Designer only. It is recommended to deploy the same changes to Runtime environments as well.

Contents

Environment configuration

Environment configurations are managed inside the JSON array block named, environments.

You can add a new environment name or update the contents of an existing entity type.

Example: Environment Configuration

"environments": [
  . . .
  {
    "environmentName": "runtime"
  }
  . . .
]

If an existing environment needs to be deleted, simply remove it from the set of values before importing the configuration package. Notice that also all the environment variables referring to the environment are needed to be removed from the imported configuration package.

Environment variables configuration

Environment variables configurations are managed inside the JSON array block named, environmentVariables.

You can add a new environment variable or update the contents of an existing environment variable.

Example: Environment Variable Configuration

"environmentVariables": [
  . . .
  {
    "environmentName": "runtime",
    "variableName": "variable",
    "variableValue": "value"
  }
  . . .
]

If an existing environment variable is needed to be deleted, simply remove it from the set of values before importing the configuration package.

Examples

Environment definition

In this example Agile Data Engine installation, there are three environments, which in these examples are RUNTIME-DEV, RUNTIME-QA and RUNTIME-PROD.

  "environments": [
    {
      "environmentName": "RUNTIME-DEV"
    },
    {
      "environmentName": "RUNTIME-QA"
    },
    {
      "environmentName": "RUNTIME-PROD"
    }
  ]

With these specified environments, we can define different environment specific variables.

Environment variables for environment specific Load scheduling

In this example, we want to specify environment specific Load schedules. In Development environment, we do not want any schedule, which means the Workflow can only be executed manually. In QA and Production environments we need to have different schedules per environment.

  "environmentVariables": [
    {
      "environmentName": "RUNTIME-DEV",
      "variableName": "cron_dv_fina"
    },
    {
      "environmentName": "RUNTIME-QA",
      "variableName": "cron_dv_fina",
      "variableValue": "0 2 * * 1-5"
    },
    {
      "environmentName": "RUNTIME-PROD",
      "variableName": "cron_dv_fina",
      "variableValue": "0 2 * * *"
    }

These variables can now be utilized in CONFIG_LOAD_SCHEDULES.

Environment variables for environment specific Snowflake Virtual Warehouses

In this example, we want to specify environment specific Snowflake Virtual Warehouses.

  "environmentVariables": [
    {
      "environmentName": "RUNTIME-DEV",
      "variableName": "fina_warehouse_name",
      "variableValue": "FINA_DEV_WH"
    },
    {
      "environmentName": "RUNTIME-QA",
      "variableName": "fina_warehouse_name",
      "variableValue": "FINA_QA_WH"
    },
    {
      "environmentName": "RUNTIME-PROD",
      "variableName": "fina_warehouse_name",
      "variableValue": "FINA_PROD_WH"
    },

These variables can now be utilized in CONFIG_LOAD_SCHEDULES.