Skip to main content

EventMappings Model

Overview​

The eventmappings table stores configuration data that maps application-level events to business logic, custom actions, screens, packages, or tasks. It enables dynamic event-driven behavior by linking user or system-generated events to the appropriate backend actions or front-end navigation.Defining what should happen when a particular business object or screen triggers an event.

Fields​

FieldTypeDescriptionRequired
idstringUnique identifier for each event mapping entry.❌
application_idstringIdentifier for the associated application.Used in multi-application environments.❌
application_item_idstringRefers to a specific application component or module where the event is applicable❌
event_idstringIdentifier for the associated event.Maps to the events table (eventId column).❌
eventIdstringeventId field❌
screen_namestringScreen or interface where the event occurs. Helps determine where the event should be triggered in the frontend.❌
business_object_idstringIdentifier for the business object linked to the event.❌
actiontypeanyDescribes the kind of action triggered (e.g., submit, delete, approve).❌
business_objectanyThe main object model related to this event mapping❌
eventanyName or type of the event being triggered (e.g., onClick, onLoad, onSubmit).❌
event_actionstringThe specific action to perform when the event occurs (e.g., redirect, save, executeWorkflow).❌
eventobjectanyA serialized or structured object that represents the event metadata or configuration❌
mapping_idanyOptional reference ID linking this mapping to another mapping set, version, or configuration group.❌
assignedpackageanyThe package/module to which this mapping is linked or assigned (may be JSON or plain text).❌
executiontypeanyHow the event is to be executed: sync, async, queued, etc.❌
customActionstringA custom-defined action name, typically handled in code or through dynamic rules❌
custompagestringCustom page or route to navigate to or render when the event is triggered.❌
executeTaskanyDescribes the backend task or job that should be executed (can be function name, workflow, etc.).❌
methodTypeanyHTTP method or internal action method type (GET, POST, PUT, etc., or internal, external).❌
selectedpkganyA specific package selected or applicable for the event context.❌
fileanyName or path of the file associated with this mapping (used in custom events or file-based configs).❌
activebooleanBoolean or flag indicating if the event mapping is active.❌
created_atdateTimestamp when the event mapping was created.❌
modified_atdateTimestamp when the event mapping was last modified.❌
event_connectoranyConnection or integration point for the event.Might define conditional flows, connectors, or integrations.❌

Sample JSON​

{
"id": "example_value",
"application_id": "example_value",
"application_item_id": "example_value",
"event_id": "example_value",
"eventId": "example_value",
"screen_name": "example_value",
"business_object_id": "example_value",
"actiontype": "example_value",
"business_object": "example_value",
"event": "example_value",
"event_action": "example_value",
"eventobject": "example_value",
"mapping_id": "example_value",
"assignedpackage": "example_value",
"executiontype": "example_value",
"customAction": "example_value",
"custompage": "example_value",
"executeTask": "example_value",
"methodType": "example_value",
"selectedpkg": "example_value",
"file": "example_value",
"active": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"event_connector": "example_value"
}