The Event Handler form is where event handlers are defined. Event Handlers can be created or updated from the Aptify Event Handler Management dashboard area. In this case, the Event Handler appears as shown in the figure on the left. Event Handlers records can also be opened directly from the Event Handlers service. In this case, the Event Handler appears as shown in the figure on the right.
Event Scope (required)
This field is only visible when the Event Handler is opened from the service. It is a series of three radio buttons indicate the scope of the event handlers displayed. By default, Entity is selected. The choices are:
- Global: The event handler is global in scope.
- Entity: The event handler is specific to an entity. The Entity field is available when this scope is selected.
- Application: The event handler is specific to an application. The Application field is available when this scope is selected.
The entity to which the Event Handler applies. For records opened from the dashboard, this field inherits the value selected on the Event Handler Management dashboard and displays as read-only when the Event Scope field on the Event Handler Management dashboard is set to Entity.
The application to which the Event Handler applies. For records opened from the dashboard, this field inherits the value selected on the Event Handler Management dashboard and displays as read-only when the Event Scope field on the Event Handler Management dashboard is set to Application.
This field links to the Event Definitions service. The event selected determines the system event that triggers this event handler.
Process Flow (required)
The process flow run by the event handler. This field links to the Process Flows service.
If more than one event handler is created for the same event, a numerical sequence determines the order the events are called.
If this option is selected, the event is active and will trigger when the event is fired. By default, an event handler is active. To disable the process flow from executing temporarily, clear this option to make the event handler inactive.
The Comments tab contains any comments relevant to the Event Handlers record.
Input Map Tab
This tab lists all data required for successful execution of the event handler. The tab inherits the input properties set up in the selected Process Flow. The event handler retrieves the specified data based on the Source Type and Source and provides this information to the process flow's context object.
Input Property (read-only)
The input property name.
Default Value (read-only)
The input property's default value.
Indicates whether or not the input property is required.
Source Type indicates the method to use in order to obtain the data necessary to fulfill the input property. The value selected in Source Type drives how the Source field is populated.
This field holds the actual source of the data that is provided to the Process Flow for the specified input property; the source's format is dependent on the value chosen in the Source Type field.
- Source Type of Static Value: Source is set to an alphanumeric string which indicates a permanent and static value to fulfill the input property. This string may include field tags, as long as the field name is enclosed in <% %>.
- Source Type of Entity Field: Source is set to a field in the entity on which the event handler is based. Applicable only when Event Scope set to Entity.
- Source Type of SQL statement: Source is set to an SQL statement to extract the data to fulfill this input property.
- Source Type of GE Object: Source is set automatically to the Generic Entity (GE) Object. A user may not enter a source for properties that use this source type.Info: If you assigned an input property a static value within a process flow step's Input Map, any value you enter in the event handler will not override the static value specified at the step level.
This field contains any additional details relevant to the Event Handler's Input Map.