Event Consumer

What is it?

The Event Consumer and Emit Event functionality enables the creation of records in other applications by setting up an Event Consumer in the destination app and configuring Emit Event in the source app.

Consumer List

Field

Alias

Description

A text field for entering the description of the setting.

Field

Name

Description

A text field for entering the identifier of the setting.

The name must be unique.

Field

Type

Description

Specifies the action types for the event setting.

Field

Available To

Description

Indicates the receiving applications or Admin Panel that will consume the event setting.

Field

Last Edited By

Description

A text field for entering the description of the setting.

Field

Last Edited Time

Description

Displays the time when the event setting was last saved.

Event Consumers Setting

Section

User Defined Key

Description

Optional / Required button: Determine if this field is optional or required
User Defined Key: Enter the name for the User Defined Key
Data Type: It supports various data types
Description (Optional): User can enter a description; this field is optional
‘+’ button: Click the add button to include an additional User Defined Key

Section

Receiving locations

Description

Determine the receiving applications or Admin Panel to consume the event setting

Supported options include:

All Apps & Admin Panel
All Apps
Selected Apps & Admin Panel
Admin Panel Only
Selected Apps Only

Section

Actions

Description

Types: Determine the event action
Type
Destination Form

Records Generated By:

Action Taker
System
Selected User

Record Workflow State (create):

Option available in the workflow list showing all states

Source

User Defined Key

Source

Text

Source

Datetime: UTC+0 time. It will be converted to the time based on the subscriber’s time zone in the run time.

Source

Time

Source

User & Group:

Support ‘User’, ‘Group’, and ‘Combine’

Support multiple value

Display Format:

Source

User Role:

Support multiple value

Remarks: In Run Time, it will be converted to User & Group value at the moment of emitting event or consuming event, it depends on the setting location.

Display Format:

Destination Columns

Widgets

Consumer Run Time Log

Field

Event Name

Description

Displays the name of the event.

Field

Consumer Type

Description

Specifies the event actions.

Field

Event Name

Description

Indicates the number of User Defined Keys received.
Users can click on the number to view the details of the keys and their values in a pop-up window.

Field

Status

Description

There are 3 possible statuses for an event: Success, Failed, and Pending.

Success: All actions in a run are successful.
Failed: There are two types of failures: the event cannot be processed, or the processing time exceeds 60 minutes, resulting in a timeout.
Pending: The run is being processed. During this time, the Run History Detail Page cannot be opened, and a message bar will display "The run is being processed.

Remark: The queue process will not time out. The timeout calculation begins once processing starts. If processing exceeds 60 minutes, the status changes to 'Failed’

Field

Triggering Source

Description

Displays either the Admin Panel or the User App Name

Field

Triggered By

Description

Displays the action taker, which can be the system or a selected user.

Field

Triggered Time

Description

Displays the time when the event was triggered.

Event Emission Log

Field

Event Name

Description

Displays the name of the event.

Field

Target Name

Description

Available options include "Admin Panel" or App Name

Field

Sent Keys

Description

Indicates the keys that were sent.
This field can be clicked to open a pop-up window showing the full list of apps that received the request.

Field

Emitted Sources

Description

Available options include:

Auto-Update Triggering
Workflow Edge

Field

Sources Details

Description

Provides details about the sources.

Field

Emitted Page Name

Description

Displays the name of the page from which the event was emitted.

Field

Emitted Form Name

Description

Displays the name of the form from which the event was emitted.

Field

Emitted By

Description

Displays who emitted the event.

Field

Emitted Time

Description

Displays the time when the event was emitted.

Detailed Step

How to Add Event Consumers

1.Navigate to App Management > Developing Environment.

2.In the side menu, select Event Consumers.

3.Click the ‘+ Event Consumer’ button to create a new event.

4.Enter the Alias and Name.

Note: The record format in the list view will be displayed as “Alias | Event Name | Event Consumer Settings”.

5.Click ‘Create & Open’.

6.Complete the required fields.

7.Click ‘Save’.

How to Copy the event

1.In the Event Consumers list, mouse over to the event you wish to copy.

2.Click the Event Consumer Settings button.

3.Edit the Alias or Name as needed.

4.Click Apply.

How to Delete the event

1.In the Event Consumers list, mouse over to the event you wish to delete.

2.Click the Delete button.

3.Confirm the deletion by clicking the Delete button in the pop-up message.

Page updated

Report abuse