AX2529

Managing event handlers

Event handlers are used to trigger Scheduler jobs based on an event. Scheduler has a number of built-in system-managed event handlers, to support certain features. Scheduler also supports user-defined event handlers.

In the Scheduler dialog, on the Event Handlers tab (Service > Event Handlers), you can view all active event handlers. This includes system-managed event handlers and user-defined event handlers. If an event handler in a job is inactive, it is not listed here.

NOTES:  

  • User-defined event handlers cannot be created in this tab; they can only be created within a Scheduler job. For more information, see Creating event handlers for a job.

  • The Event Handlers tab is only visible to administrators. Non-admin users with the Scheduled Job Users permission can only manage event handlers within the jobs they have access to.

For each event handler, the following information is displayed.

  • Event Name: The name of the event handler.

  • Job: The job associated with the event handler. For system event handlers, the job is a system job. For user-defined event handlers, the job is the job where the event handler was created. Multiple jobs can contain a user-defined event handler with the same name (in which case the event handler is listed multiple times).

  • User: The user identity that will be used to execute jobs triggered by the event handler. If the event handler is configured to run as the requester, then (Requester) is listed here. If the event handler is configured to run as the owner, then the owner name is listed here (either a specific user name, or System).

    If you want to change how the event handler runs, you can double-click the event handler name to open and edit the associated job. Go to the Event Handlers section and then edit the Execute As setting for the event handler.

Removing event handlers

You can remove an event handler by right-clicking the event handler and selecting Remove event handler.

IMPORTANT: You should only remove a system event handler if the event handler has become corrupted and you need to restore a new copy of it. If you remove a system event handler and then do not restore a new copy, the associated system functionality will become unavailable.

For user-defined event handlers, removing the event handler inactivates it within the job; it does not delete the event handler. If you want to delete the event handler entirely, you must edit the job to delete it.

Creating system jobs and system event handlers

If any system jobs or event handlers are accidentally or deliberately removed from the system, you can restore new copies by right-clicking any event handler and selecting Create system jobs and event handlers. Any missing event handlers or system jobs will be re-created. You must refresh the Event Handler tab to see the re-created event handlers.

System event handlers

Axiom Software uses the following system event handlers.

Event Handler Description

System.ApplyUserTableConstraints

Applies constraints to tables as needed. Operates as a system job.

System.RebuildPartitionedTables

Rebuilds partitioned tables as needed when the partitions change. Operates as a system job.

System.RefreshDocumentList

Processes individual documents as part of various utilities. The job is performed as the user who executed the utility. The job is not processed on the system Scheduler server.

System.RefreshPlanFiles

Creates a Process Plan Files job when a user selects to run the Process Plan Files utility (from the file group menu) on the Axiom server instead of locally. The job is performed as the user who executed the utility. The job is not processed on the system Scheduler server.

System.SMTPMessageDelivery

Sends email notifications for Axiom Software. Operates as a system job.

System.WorkflowInititation

Handles background processes when a workflow is activated. Generates the initial set of workflow tasks. Supports the legacy workflow feature (is only present in systems where Workflow is enabled). Operates as a system job.

System.WorkflowUpdate

Handles background processes for plan file progression in a workflow. Moves the plan file to the appropriate stage and generates the new workflow tasks. Supports the legacy workflow feature (is only present in systems where Workflow is enabled). Operates as a system job.