Custom Action Condition Types

Overview

Action Condition Types define the logic that determines whether an Action is allowed to execute under specific conditions. This mechanism ensures that actions are only triggered when predefined rules are met.

Each Action has a Conditions Type field that determines how the execution rules are defined. The system supports two built-in condition types and also allows for custom ones.

Condition Types

Basic

When the Basic type is selected, a simple rule builder UI is displayed, allowing users to define conditions using common logical comparisons. These conditions are evaluated based on the current entity context.

Examples:

• Status is "Completed"
• Quantity > 10

Script

When the Script type is selected, users can write condition logic using the Twig templating language. This provides more flexibility and allows referencing complex expressions and conditions.

Example:

{% set proceed = entity.status == 'completed' and entity.priority > 2 %}
{{ proceed }}

Custom Condition Types

For advanced use cases where neither Basic nor Script types are sufficient or performant — for example, when complex data relationships or multiple database lookups are required — the system provides support for Custom Condition Types.

Use Cases for Custom Conditions

• Determine eligibility based on relationships across multiple entities.
• Implement role-based restrictions based on a dynamic permission model.
• Perform cross-entity validation or join-based lookups in the database.
• Evaluate external data or trigger remote validation services.

Best Practices

• Optimize Logic: Keep the canExecute() method efficient and avoid unnecessary database queries.
• Use Services: Leverage existing service classes to encapsulate complex logic or data access.
• Keep It Focused: Design each condition type for a single, clear purpose to improve reusability and maintainability.

Creating a Custom Condition Type

To create a new custom condition type, run the following command on the server:

php console.php create action condition type OwnCondition

Here, OwnCondition is the name of your custom condition class.

This command generates a PHP file with the following structure:

<?php

namespace CustomActionConditionTypes;

use Atro\ActionConditionTypes\AbstractActionConditionType;
use Espo\ORM\Entity;

class OwnCondition extends AbstractActionConditionType
{
    public static function getTypeLabel(): string
    {
        return 'OwnCondition';
    }

    public static function getEntityName(): string
    {
        return 'Product';
    }

    public function canExecute(Entity $action, \stdClass $input): bool
    {
        return true;
    }
}

Key Methods