Skip to main content
Version: 2024.1

Configuration

In general, Pimcore Copilot lists all actions which are registered, details see here.

There are two groups of actions, which can be added via configuration though:

This configuration can be done via configuration dialog in the Admin Backend UI or via symfony configuration files. For details see the corresponding detail section.

Configuration Dialog​

The configuration dialog allows administrators (and other users with corresponding permissions) to add and configure automation and interaction actions directly in the user interface.

Configuration OverviewConfiguration OverviewConfiguration Overview

In the general tab you can configure the title, a description, an icon that will be used in the Copilot window and if the action should be expanded when started. The name of the action can be translated via translations in the scope pimcore_copilot.

The additional tabs allow configuration of all other settings for the actions.

Configuration Storage​

The configuration user interface utilizes the LocationAwareConfigRepository for storing the configuration. In the symfony tree the storage location can be configured, possible values are

  • symfony-config - write configs as Symfony Config as YAML files to /var/config/pimcore_copilot, more specifically in sub-folders as interaction_actions and automation_actions
  • settings-store - write configs to the SettingsStore
  • disabled - do not allow to edit/write configs at all

Details also see Pimcore Docs.

Example​

pimcore_copilot:
  config_location:
    automation_actions:
      write_target:
        type:                 symfony-config # One of "symfony-config"; "settings-store"; "disabled"
        options:
          # Default:
          directory:           /var/www/html/var/config/pimcore_copilot/automation_actions
    interaction_actions:
      write_target:
        type:                 symfony-config # One of "symfony-config"; "settings-store"; "disabled"
        options:
          # Default:
          directory:           /var/www/html/var/config/pimcore_copilot/interaction_actions

Configuration via Symfony Configuration​

Additionally, it is also possible to define the configuration directly in a symfony configuration file without using the configuration user interface. In this case, the configuration user interface for these actions is just read only.

For details see bin/console config:dump-reference pimcore_copilot or corresponding detail configuration pages.