Emit Event

What is it?

The Emit Event is a function that enables information transmission and completes setting actions between different systems after certain conditions are triggered. 

How and When to use it?

Two Major Parts: 

1. Sender: Be responsible for emitting events to the Consumer after certain specific situations occur.

   • User App Emit Event

     1. • Page Builder

        • Workflow Builder

   • Admin Panel Emit Event

2. Consumer: Receiving events emitted by the sender, complete a series of actions according to the preset logic.

• • User App Consumer

  • Admin Panel Consumer

How to configure it?

Page Builder

Setup Process:

1. Navigate to Page List and open the desired page for editing.

2. Create or access a "Form" to view the "Auto-Update Triggering" section.

(Here, users can create, modify, or manage Emit Event.)

Creating a New Rule:

1. On the Auto-Update Triggering page, select "+ New Rule".

2. Choose "Emit Event" as the rule type.

Detailed explanations for each part follow in below sections.

Trigger Widget

This section displays all form input fields. 

Users may:

1. Select one or multiple inputs.

2. When data changes occur in these fields, the system will automatically trigger an event to the Consumer application.

Event Name

1. Establishes connection parameters with the Consumer.

2. Allows custom event naming via free-text input field.

Destination App

There are three options: 

• Apps Only

  • Events sent exclusively to selected apps.

  • Option to choose specific applications or "All Apps".

• Admin Panel Only

• Apps & Admin Panel

  • Events broadcast to both apps and Admin Panel.

  • Includes application selection capability.

  • "All Apps" option available.

Mapping

This section defines the data payload to be transmitted to the Consumer. 

Users must:

1. Specify Source Values

   • Select the appropriate data type for each value.

   • Enter the data to transfer in the Source Column.

2. Configure Destination Keys

   • Assign a Destination Key for each source value.

   • Ensures proper mapping and interpretation by the Consumer.

Trigger Selection determines when events are emitted:

1. When unchecked: Events send in nearly all scenarios.

2. When checked: Enables conditional event triggering(Conditional is based on Specific States).

Workflow Builder

The Workflow Builder exclusively associates Emit Event functionality with Edge elements. 

Key characteristics:

1. Only Edges contain the "Emit Event List" configuration.

2. Event emission occurs solely when executing the specific Edge where the Emit Event is configured.

For example. Consider a workflow with three Edges:

• Submit Edge (No Emit Event configured)

• Approve Edge (No Emit Event configured)

• Reject Edge (With Emit Event configured)

In this scenario:

1. Events will only be emitted to the Consumer when executing the Reject Edge.

2. No events will be triggered during Submit or Approve Edge execution.

The first three configuration sections (1-3) mirror the corresponding settings (2-4) in Page Builder. For detailed explanations of these parameters, please reference the Page Builder documentation provided earlier.

Part 4, Alias Configuration.

Allows users to add descriptive context to Emit Event settings.

Implementation:

1. Locate the Alias field in the Emit Event List.

2. Enter a clear, meaningful description of the current configuration.

Admin Panel Emit Event

The Admin Panel is a key feature that allows authorized users to adjust system settings. Access and configuration rights vary depending on the user's assigned role. Users can edit Admin Panel Emit Event according to the steps below.

Detailed explanations for each part follow in below sections.

Triggering Action

The system supports four triggering actions for event emission. Users may select from the following options based on their specific requirements:

1. Create a New User Account

2. Update an Existing User Account

3. Activate an User Account

4. Deactivate an User Account

Triggering Fields

The "Update an Existing User Account" action requires supplemental configuration to specify which updates should trigger the event. Users must explicitly define these parameters during setup.

Admin Panel to

There are two options: 

1. User App

Requires additional configuration:

1. • Environment: Select the appropriate environment.

   • Destination App: Specify the target apps.

2. Admin Panel 

No additional selection required.

Mapping

The Mapping function enables users to define precise data transmission parameters to the Consumer:

1. Source Specification

   • Select the appropriate data type for each value.

   • Enter the data value to be transferred in the Source Column.

2. Destination Configuration

   • Assign a Destination Key for each source entry.

   • Ensures accurate data pairing and interpretation by the Consumer.

User App Consumer

To edit User App Consumer:

1. Navigate to Event Consumers.

2. Select the "+ Event Consumer" button.

Detailed explanations for each part follow in below sections.

Users need to set:

1. User Defined Key

2. Data Type

Receiving Form

The system allows precise specification of which request components the Consumer can process. 

The following acceptance parameters are available:

1. All Apps & Admin Panel

2. All Apps

3. Selected Apps & Admin Panel

   • Specifically chosen applications

4. Admin Panel Only

5. Selected Apps Only

   • Specifically chosen applications

There are four parts need to be edited:

1. Type

2. Records Generated By

3. Destination Form

4. Record Workflow State (create)

These will be explained in detail below:

1. Type

The Type field determines the Consumer's action upon receiving an Emit Event request. 

For User App Consumers:

Currently supports one action type: "Generate a Record".

4. Record Workflow State (create)

Choose the corresponding Workflow State. 

Then configure field mapping using either:

1. Predefined keys

2. Custom source definitions

Admin Panel Consumer 

Users can edit Admin Panel Consumer according to the steps below.

Access Admin Panel:

1. Click the user profile icon in the upper right corner.

2. Select "Admin Panel" from the dropdown menu.

Navigate to Event Consumers:

In the left navigation menu:

1. Under the "Subscriber".

2. Click "Event Consumer".

Create New Consumer:

1. Click the "+ Event Consumer" button 

Complete the required fields:

1. • Alias

   • Event Name

2. Click "Create & Open" to:

   • Save the new consumer configuration

   • Proceed to detailed settings

There are four parts can be edited:

1. User Defined Key

2. Receiving App

3. Flow of Actions

These will be explained in detail below:

User Defined Key

Configure both:

1. User Defined Key

2. Data Type

Receiving App

1. Defines which request components the Consumer processes.

2. Select the appropriate Environment for event routing.

Flow of Action

Determines sequential actions upon event acceptance.

Key Features:

1. Supports multiple consecutive actions (unlike User App Consumers).

2. Implements sequential processing - subsequent actions abort if any step fails.

Users can create actions by clicking "+ New Action".

Users can choose the following actions:

Configure both:

1. Target User Account

2. Mapping 

To prevent redundant actions with identical names to the Emit Event:

1. Enable the "Suppress an Event Triggering" option (located at the bottom)

2. This ensures:

   • Only the intended action executes

   • Potential Emit Events with matching names are ignored

Where to see the result?

Emit Event

All Emit Event transactions are recorded and available for review in the Admin Panel:

1. Navigate to: Emission Log section.

2. View comprehensive history of all emitted events by clicking Event Name.

Consumer

All Emit Event transactions are recorded and available for review in the Admin Panel:

1. Navigate to: Consumer Run History section.

2. View comprehensive history of all emitted events by clicking Event Name.

3. Check the Status

Also can be checked in Event Consumers:

1. Select the target app

2. Go to Event Consumers page

3. Select Consumer Run Time Log