Defining Entity Interactions

In the platform, entity interactions aim to perform a specific action when an event occurs at the entity level. To add an interaction, follow these steps:

1. Go to the Administration menu.
2. Select "Applications" then "Modules."
3. Find the relevant module, then go to the Entities tab and locate the specific entity.
4. Click on the menu icon (three vertical dots) at the top right of the entity card.
5. Choose "Edit Entity."
6. Navigate to the "Interactions" tab.
7. Click on "Add Interaction" to open the interaction settings screen.
8. Add a name for the interaction (a required field that supports translation).
9. Choose the event that will trigger the interaction.
10. You can filter the event outputs using criteria.
11. Select the action to be executed when the event meets the filtering criteria.

Events

Events in the platform are changes that occur to entries within an entity. Based on these events, the system performs specific actions under certain conditions set by the administrator.

Entry Created Event

This event means that when a new entry is created in the entity where this interaction is defined, the system marks this creation as an event and automatically executes the programmed action.

Entry Updated Event

This event means that when an entry in this entity is modified, the system marks this modification as an event and automatically executes the programmed action.

Entry Archived Event

This event means that when an entry in this entity is archived, the system marks this archiving as an event and automatically executes the programmed action.

Timer Event

The platform can link event generation to a specific time period. The timer can be:

• One-time: The event is generated when the timer condition is met, executing the action.
• Recurrent: Within two time periods (daily, weekly, monthly) using a cron expression, the event is triggered whenever the condition is met.

Arrival Event

This event is generated when an entry reaches a specific step in the workflow defined by the user, executing a specific action in the system.

For more information, click here.

Exit Event

This event is generated when transitioning from one step to another in the workflow, executing a specific action based on the transition option.

For more information, click here.

Custom Event

A custom event is linked to a button added to each entry's options. This event is generated when the button is pressed, triggering the programmed action.

For more information on creating the button, click here.

Execution Indicator

By following this guide, you can set the "Execution Indicator" option for an interface interaction and configure how the indicator is displayed during interaction execution, helping to enhance the user experience.

Steps:

1. Log in to the system as an administrator.
2. Go to the entity where you want to create an interaction.
3. Go to the entity settings.
4. Click on the Interactions tab.
5. Click on "Create New Interaction."
6. Choose a custom event from the list of events.
7. A section titled "Execution Indicator" will appear.
8. When you click on "Execution Indicator," the system will display the following options:
   • Block: Displays a loading indicator and prevents the user from performing any action until the interaction is completed.
   • Notify: Displays a loading indicator and allows the user to navigate to another page.
   • None: Does not display any indicator and allows the user to navigate to another page.
9. Choose an action.
10. Save the interaction.
11. Link the interaction to a button. For more information on creating the button, click here.

Executing an Interface Interaction Based on Execution Indicator Options

1. Log in to the system as an end user.
2. Go to the list that has access permissions and contains the interface button linked to the interaction with the execution indicator specified.
3. Execute the interface interaction by pressing the button linked to the interaction.
4. The indicator will be displayed according to the selected settings in the interaction.

Execution Indicator	Indicator
Block	Displays a loading indicator and prevents the user from performing any action until the interaction is completed
Notify	Displays a loading indicator and allows the user to navigate to another page
None	Does not display any indicator and allows the user to navigate to another page

Setting Success and Failure Messages for Interface Interaction Execution

Setting the Start Message for Interaction

1. Log in to the system as an administrator.
2. Go to the entity where you want to create an interaction.
3. Go to the entity settings.
4. Click on the Interactions tab.
5. Click on "Create New Interaction."
6. Choose a custom event from the list of events.
7. A section titled "Execution Indicator" will appear.
8. When you click on "Execution Indicator," select Block.
9. The system will display a dialog box when the interaction starts.
10. The default message "Interaction started successfully" will appear inside the box.
11. Enter the message you want to display when the interaction starts.

Setting the Success Message for Interaction

1. Log in to the system as an administrator.
2. Go to the entity where you want to create an interaction.
3. Go to the entity settings.
4. Click on the Interactions tab.
5. Click on "Create New Interaction."
6. Choose a custom event from the list of events.
7. A section titled "Execution Indicator" will appear.
8. When you click on "Execution Indicator," select Block.
9. The system will display a dialog box when the interaction starts.
10. The default message "Interaction started successfully" will appear inside the box.
11. Enter the message you want to display when the interaction is successful.

Executing an Interface Interaction with Start/End Messages

1. Log in to the system as an end user.
2. Go to the list that has access permissions and contains the interface button linked to the interaction with the execution indicator specified.
3. Execute the interface interaction by pressing the button linked to the interaction.
4. A loading indicator will appear, preventing the user from performing any action until the interaction is completed.
5. The start message specified in the interaction settings will be displayed to the user.
6. Upon successful completion of the interaction, the specified end message will be displayed to the user.

Interface Event

In this event, you can activate a specific interface event option, allowing the end user to design the details of the action.

Interaction Success Event

This feature allows you to create sequential interactions that depend on the success of previous interactions. This guide explains how to set up a new interaction that executes when a previous interaction succeeds and how to use the results of this interaction in action settings.

Defining an Interaction with an "Interaction Success" Event

Defining Interaction 1:

1. Create a new interaction.
2. Save the interaction with the name "Interaction 1."
3. Select an interface event (e.g., button click).
4. Select an action (e.g., create entry).

Defining Interaction 2:

1. Create a new interaction.
2. Save the interaction with the name "Interaction 2."
3. Choose an event titled "Interaction Success."
4. The system will configure the interaction settings to match the triggering interaction (the one whose successful execution triggers the current interaction) in terms of context.
5. The system will display all entities within the current module. Select the entity that contains the triggering interaction.
6. All interactions defined in this entity will be displayed. Select the desired interaction.

Using Interaction Results in Action Settings in Interaction 2:

1. While configuring actions in "Interaction 2," the user can choose the outputs or inputs of "Interaction 1" as a value for a field in the action within "Interaction 2."
2. Select the appropriate field from the outputs or inputs of "Interaction 1" to use in "Interaction 2."

Triggering an Interaction Based on the Success of Another Interaction

Executing Interaction 1:

1. Log in to the platform as an end user.
2. Perform the action that triggers "Interaction 1" (e.g., clicking a button).

Success of Interaction 1:

1. Upon successful execution of "Interaction 1," the system will automatically trigger "Interaction 2."

Filtering Interaction Inputs

Filtering interaction inputs means applying a condition to the entries to which the interaction applies, executed similarly to queries. For more information on creating a query, click here.

Example: If the event is creating an entry, a condition can be added so that the event is generated only when the entry is created by a specific number of users and not everyone.

Actions

Platform interactions include actions that allow executing specific commands dynamically when interaction events and conditions are met.

Create Entry Action

This action helps the administration user automate the creation of a new entry in the entity dynamically under specific conditions. The current entity or another entity in the system can be selected, and the required field values can be set.

Update Entry Action

This action helps the administration user automate the modification of an existing entry in the entity under specific conditions. The current entity or a related entity can be selected, and the fields and their values can be chosen.

Archive Entry Action

This action helps the administration user archive a specific entry, linked entries, or entries resulting from a specific query when the interaction is triggered.

Creating an Interaction that Archives an Entry

1. Log in to the system as an administrator.
2. Select the entity where you want to create an interaction.
3. In the Interactions tab, create a new interaction or modify an existing one.
4. Select any event from the list of available events.
5. Choose the "Archive Entry" action from the list of actions:
   • The system will display a dropdown menu titled "Scope."
   • Select "This Entry."
   • The entry on which the interaction was executed will be archived.

Creating an Interaction that Archives a Linked Entry

1. Log in to the system as an administrator.
2. Select the entity where you want to create an interaction.
3. In the Interactions tab, create a new interaction or modify an existing one.
4. Select any event from the list of available events.
5. Choose the "Archive Entry" action from the list of actions:
   • The system will display a dropdown menu titled "Scope."
   • Select "Linked Entries."
   • The system will display a list of inbound relations defined at the entity level in the "Relation" field.
   • Select the relation whose linked entries will be archived when the interaction is executed.

Creating an Interaction that Archives Entries Resulting from a Query

1. Log in to the system as an administrator.
2. Select the entity where you want to create an interaction.
3. In the Interactions tab, create a new interaction or modify an existing one.
4. Select any event from the list of available events.
5. Choose the "Archive Entry" action from the list of actions:
   • The system will display a dropdown menu titled "Scope."
   • Select "Saved Query."
   • The system will display a list of saved queries defined at the entity level in the "Queries" field.
   • Select the query whose resulting entries will be archived.

Send Notification Action

This action helps the administration user send notifications within the system. It requires specifying the notification title and content and selecting the recipient from the available options (user, group, list).

Send Email Action

This action helps the administration user send an email. It requires specifying the email subject and content and selecting the recipient from the available options (user, group, list, fixed).

Send SMS Action

This action helps the administration user send text messages. It requires specifying the message content and selecting the recipient from the available options (entity, list, fixed).

Call External API Action

This action helps the administration user call external APIs and integrate external software by receiving and sending data. It includes various request types (GET, POST, PATCH, PUT, DELETE).

Execute Workflow Step Action

This action helps the administration user execute an action within workflow steps when a specific condition is met.

Move Workflow to Step Action

This action helps the administration user move to a specific step in the workflow when a specific condition is met.