Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

Overview

  • The Subscribe Event action is used to listen for events that are emitted by a source layout or workflow.

  • When the subscribed event occurs, the action enables the workflow to respond accordingly by executing predefined steps or capturing input parameters.

image-20240909-141125.png

  • It allows for real-time interaction between different parts of the application, ensuring that workflows or layouts can react dynamically to specific events emitted by other components.

  • Let’s explore the screens that follow, after drag-n-drop of Subscribe Event action on workflow canvas.

Config

image-20240819-061744.png

Config Field

Description

Layout

It allows to choose layout from which one wants to subscribe event.

Event

It allows to choose specific event to emit from the layout.

Note: By default, this will show blank, if the layout is not chosen.

Workflow

It allows to choose workflow through which the event will be fired or emitted.

Variable Mapping

It allows to map event variables with Workflow variables.

Reference: Variable Mapping

Unsubscribe Once Emitted Event

If checked, the event will be unsubscribed once emitted.

Variable Mapping

After clicking on + button, following screen for variable mapping opens up.

image-20240819-071651.png

Variable Mapping Field

Description

Event Variable

It enables to choose the event variable to be mapped.

Destination Type

It enables to choose the destination with which the variable is to be mapped with. It contains:

  1. Variable

  2. Static

  3. Cookie

  4. Locale Storage

  5. Query Param

  6. User

  7. Model

Destination Field

It enables to choose the exact field or variable on which the event variable will be mapped.

Note: By default, this field is invisible. It will only be visible if the destination type is specified.

Action Details

image-20240819-071521.png

Attribute Name

Description

Label

A user-friendly name for the action, used for easy identification within the application.

Name

The unique identifier for the action, typically used in code or within merge text.

Is Async?

Decides whether the action will be performed in async context or within sync context.

Description

A user-friendly description for the action, used for easy apprehend within the application.

Is Async : Brief Explaination

image-20240911-043804.png

Is Async checkbox provides flexibility in managing how actions within workflows are executed in relation to system transactions. Here's how it works:

  • Single Transaction Execution: When multiple actions within a workflow have Is Async set to false, they are executed within a single transaction. This ensures that all actions complete successfully, or if one fails, the entire transaction is rolled back, maintaining data integrity.

  • Breaking Transactions: When an action within the workflow has Is Async set to true, a new transaction is initiated at that point. This allows for separation between the actions, enabling different parts of the workflow to be processed independently.

  • Handling Large Data: The Is Async feature is especially useful when working with large amounts of data that may risk hitting system governor limits. By setting certain actions as asynchronous, you can ensure that the workflow avoids limits by breaking the execution into multiple transactions.

This feature empowers users to control how workflows behave during execution, optimizing performance and avoiding potential issues with system resources.

  • No labels