Skip to content
Snippets Groups Projects

docs/eca/install.md, docs/eca/usage.md

Open docs/eca/install.md, docs/eca/usage.md
michaellenahan/eca:feature/initial-review into develop
Open Michael Lenahan requested to merge michaellenahan/eca:feature/initial-review into develop
Viewing commit 51a52bb2
Prev Next
Show latest version
1 file
+ 34
− 11
Compare changes
  • Side-by-side
  • Inline
docs/eca/install.md
+ 34
− 11
@@ -6,16 +6,22 @@ tags:
# Installing the ECA module
This guide explains how to install the Events - Conditions - Actions (ECA) module and its required components on your Drupal site. The installation process includes both the core ECA module and a modeller, which provides the user interface for creating automation models.
This document explains how to install the Events - Conditions - Actions (ECA)
module and its required components on your Drupal site.
The installation process includes both the core ECA module and a modeler, which
provides the user interface for creating automation models.
## Prerequisites
Before installing ECA, ensure your system meets these requirements:
Your Drupal site must be up and running with administrative access. You need to have Composer installed to manage the module dependencies.
Before installing ECA, your Drupal site should be up and running with
administrative access.
You need to have Composer installed to manage the module dependencies.
## Installing with Composer
Use Composer to download the `eca` Drupal module and the recommended `BPMN.iO` modeller. The `BPMN.iO` modeller provides a visual interface for creating your automation models.
Use Composer to download the `eca` Drupal module and the recommended `BPMN.iO`
modeler.
The `BPMN.iO` modeler provides a visual interface for creating your automation models.
```shell
composer require drupal/eca drupal/bpmn_io
@@ -23,18 +29,35 @@ composer require drupal/eca drupal/bpmn_io
## Enabling the modules
After downloading the modules, you need to enable them in Drupal. You can do this through Drupal's administrative interface or using `drush`.
Through Drupal's administrative interface, sign in as an administrator and go to the Extend page (/admin/modules). Find and enable the following modules: `Events - Conditions - Actions (ECA)`, `ECA Base`, and `BPMN.iO Modeller`. Select "Install" to complete the process.
Alternatively, if you prefer using `drush`, you can enable the modules with this command:
After downloading the modules, you need to enable them in Drupal.
You can do this through Drupal's administrative interface or using `drush`.
In Drupal, sign in as an administrator and go to the `Extend` page
(`/admin/modules`).
Find and enable the following modules: `ECA Core`, `ECA Base` and
`BPMN.iO Modeller`.
Select "Install" to complete the process.
Alternatively, if you prefer using `drush`, you can enable the modules with this
command:
```shell
drush -y pm:install eca eca_base bpmn_io
```
## Next steps
## Additional ECA sub-modules
After completing the installation, you can begin exploring ECA's capabilities. Start by learning about [basic ECA concepts](/eca/concepts), read the [usage guide](/eca/usage.md), or explore our [library of example models](/library) for common use cases. The [concepts documentation](/eca/concepts) will help you understand how ECA can automate tasks on your Drupal site.
You might want to install additional ECA sub-modules.
These sub-modules add support for extra events, conditions, and actions.
## Additional components
ECA is also supported by a large number of Drupal contrib modules.
Review the [extension guide](/eca/extend) and [plugin documentation](/plugins)
to learn about available modules and how they can help you build more sophisticated
automation models.
## Next steps
You might want to install additional ECA components depending on your specific needs. These components enhance ECA's functionality by adding support for specific types of events, conditions, or actions. Review our [extension guide](/eca/extend) and [plugin documentation](/plugins) to learn about available components and how they can help you build more sophisticated automation models.
After completing the installation, you can begin exploring ECA's capabilities.
Start by learning about [basic ECA concepts](/eca/concepts), read the
[usage guide](/eca/usage), or explore the
[library of example models](/library) for common use cases.