Skip to main content
Version: 2024.3

Environment Variables

Environment Variables are used in Automation Actions to define values that a user has to enter before starting an action. Those values are defined globally for the action and can be used in the action steps.

Types of Environment Variables​

Following types of environment variables are available:

  • Checkbox
  • Date
  • Matrix
  • Number
  • Select
  • Text

Checkbox​

Checkbox only has one configuration option:

required: true

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Checkbox

Date​

Date has the following options:

required: true
default_value: '2024-01-01'

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Date

Matrix​

A matrix can consist of multiple columns which can be again environment variables. Except another matrix type all environment variable types with their corresponding configurations.

required: true
columns:
  - configuration:
      required: true
      values:
        - key: grey
          value: Grey
        - key: beige
          value: Beige
        - key: silver
          value: Silver
    name: Color
    type: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Select
  - configuration:
      required: false
    name: ProductionYear
    type: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Number

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Matrix

Number​

Number has the following options:

required: true
default_value: 10

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Number

Select​

Select consists of one or multiple values. A value consists of a key and a value. The key is used as the value of the environment variable and the value is used as the label.

required: true
values:
- key: grey
  value: Grey
- key: beige
  value: Beige
- key: silver
  value: Silver
default_value: beige

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Select

Text​

Text only has one configuration option:

required: true
default_value: 'Default text'

Type for configuration file: Pimcore\Bundle\CopilotBundle\AutomationAction\Configuration\Environment\Type\Text