Important

You are browsing documentation for version 6.1 of OroCommerce, supported until 2029. Read the documentation for the latest LTS version to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Operations (Actions) Glossary 

  • Buttons are a user interface component that delivers custom actions for user interaction. Through a specific ButtonsProviderExtension together with Buttons matched by a context, they surface these actions (operations, for example) to the UI in the proper context.

  • Operation are configured user interaction elements (buttons, links or even further: forms, pages) with customized execution logic. One of the main components is ActionBundle. It handles the specific operation logic, how and when a UI element is displayed, the reaction it provides, and how to aggregate the data retrieved from a user (usually through a form) into execution unit values before launching the configured Actions.

The operation definition contains the most important information, such as operation related entity classes (‘AcmeBundleDemoBundleEntityMyEntity’), or routes (‘acme_demo_myentity_view’), or datagrids (‘acme-demo-grid’).

The operation can be enabled or disabled. Its other fields hold its name, extended options, and order of displayed buttons. For more options, refer to Operation Configuration.

  • Action Group is a set of backend actions that implement complex business logic, grouped together under named configuration nodes. It is another key component in ActionBundle: a named group of actions with entry parameters (required or optional, typed or not) and conditions.

    You can use Action groups not only from an operation but also within workflow processes and in any part of the OroPlatform configuration nodes that understand Actions.

A special @run_action_group action runs a group of actions as a single one. (For more information, refer to *ActionGroup* configuration and the @run_action_group action.)

  • Condition - defines whether Operation or ActionGroup is allowed. Conditions use ConfigExpression syntax and can be nested within each other.

  • Actions - simple functional blocks (described in Action Component). You can use them in ActionGroups or Operations to implement the preparation logic before conditions, to retrieve rendering data, and to initialize and execute the logic afterward.

    • Operations contain the following actions: Preactions (preactions), the Form Init actions (form_init), and Actions themselves with the functions of Action Component. The difference is that preactions run before the operation button renders, while the form_init actions run before the form displays. Actions can perform any operations with data in their context (called Action Data) or other entities.

    • Definition — part of Operation or ActionGroup that contains the configuration of the component itself and describes its behavior.

  • Attribute — an entity that represents a value (mostly in Operation) and renders a field value in a step of a form. The attribute knows about its type (string, object, entity, etc.) and additional options. It also contains a name and label as additional parameters.