Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
ECA Guide
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Service Desk
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Drupal
Documentation
ECA Guide
Merge requests
!125
docs/eca/install.md, docs/eca/usage.md
Code
Review changes
Check out branch
Download
Patches
Plain diff
Open
docs/eca/install.md, docs/eca/usage.md
michaellenahan/eca:feature/initial-review
into
develop
Overview
11
Commits
16
Pipelines
8
Changes
2
9 unresolved threads
Hide all comments
Open
Michael Lenahan
requested to merge
michaellenahan/eca:feature/initial-review
into
develop
2 months ago
Overview
11
Commits
16
Pipelines
8
Changes
2
9 unresolved threads
Hide all comments
Expand
0
0
Merge request reports
Compare
develop
version 7
dcdfce63
1 month ago
version 6
41a3c7af
1 month ago
version 5
008e44e9
1 month ago
version 4
f4b48f90
1 month ago
version 3
3a3775ad
2 months ago
version 2
51a52bb2
2 months ago
version 1
1fdd4e10
2 months ago
develop (HEAD)
and
latest version
latest version
5501946a
16 commits,
1 month ago
version 7
dcdfce63
14 commits,
1 month ago
version 6
41a3c7af
11 commits,
1 month ago
version 5
008e44e9
10 commits,
1 month ago
version 4
f4b48f90
9 commits,
1 month ago
version 3
3a3775ad
8 commits,
2 months ago
version 2
51a52bb2
7 commits,
2 months ago
version 1
1fdd4e10
6 commits,
2 months ago
2 files
+
135
−
122
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
2
Search (e.g. *.vue) (Ctrl+P)
docs/eca/install.md
+
41
−
8
Options
---
title
:
Install
ation
title
:
Install
ing the ECA module
tags
:
-
install
---
# Installation
ECA can use different modellers. The recommended BPMN.iO modeller is used in this Quick Start guide.
# Installing the ECA module
Download the ECA module and BPMN.iO modeller module:
This document explains how to install the Events - Conditions - Actions (ECA) module 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, 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`
modeler.
The
`BPMN.iO`
modeler provides a visual interface for creating your automation models.
```
shell
composer require drupal/eca drupal/bpmn_io
```
Install the ECA and BPMN.iO module and their dependencies via the GUI at
`/admin/modules`
or with Drush:
## 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`
.
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
```
The list of modules you may want to install depends on your use-case. You can now start building your own models.
## Additional ECA sub-modules
You might want to install additional ECA sub-modules.
These sub-modules add support for extra events, conditions, and actions.
ECA is also supported by a large number of Drupal contributed 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
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.
Loading