Event Handlers

The Event Handlers page includes a list of event handlers and the type of event the event handler is configured to execute on.

To access this feature, you must have permission to access the Administration Tools.

The key concepts of event handlers are:

  • Events: An event is an action or occurrence that can be generated or triggered by the system, by the user or in other ways.
  • Event Handlers: An event handler is a routine that deals with the event. This allows a programmer or user to write scripts that are automatically executed when the event occurs.
  1. On the top navigation tabs, click the Setup tab.
  2. In the Administration Tools section, expand Automation and click Event Handlers.
    The Event Handlers page is displayed.
  • Company
    • Company Create
  • Cost
    • Budget Change Void
    • Commitment Approve
    • Commitment Change Void
    • Commitment Invoice Approve
    • Commitment Invoice Created
    • Commitment Invoice Void
    • Commitment Void
    • Funding Source Created
    • General Invoice Approve
    • General Invoice Created
    • General Invoice Void

  • Document

    • Document Uploaded
  • Project
    • Project Created
    • Project Updated
  • Submittal
    • Submittal Item Closed
    • Submittal Package Closed
  1. Go to the Event Handlers page.
  2. Click Add Event Handler.
  3. On the Event Handler page, complete all necessary fields (marked with an *):
    • Name*: Enter a name for the event handler.
    • Run As User: Click Lookup to search for and select a user's name to run the event handler as the selected user.
    • Event Type*: Select the type of event from this drop-down list.
    • Script*: Enter the script to be run when the event occurs.
  4. Click Save.

Event handlers can be edited using the Edit Event Handlers page.

To edit an event handler

  1. Go to the Event Handlers page.
  2. Click Edit beside the event handler you wish to modify.
  3. On the Edit Event Handlers page, modify the following fields as needed:
    • Name*: Enter a name for the event handler.
    • Event Type*: Select the type of event from this drop-down list.
    • Script*: Enter the script to be run when the event occurs.
  4. Click Save.

You can disable an already existing event handler if you no longer wish to use it. The same event handler can be re-enabled later as well.

  1. Go to the Event Handlers page.
  2. Click the Enable/ Disable toggle beside the event handler you wish to enable or disable.

An existing event handler can be permanently deleted from e-Builder.

To delete an event handler

  1. Go to the Event Handlers page.
  2. Click Delete beside the event handler you wish to remove.
  3. Click Yes to confirm the deletion.

Administrators can view the execution history of event handlers in e-Builder.

To view the history of an event handler

  1. Go to the Event Handlers page.
  2. Click Show History beside the event handler to view its history.
    The Event Handler History window is displayed.
  3. Use the following Filter section to sort the history records:
    • Show Only Failed: Select this check box to display only failed event handler results.
    • Start Date: Select a date range for the event handler history records in the From and To fields.
  4. The following fields are displayed for the event handler:
    • Name: The name for the event handler.
    • Event Type: The type of event.
    • Start Date: The date and time when the system started executing the event handler script.
    • Execution Time: The time taken in minutes and seconds to execute the event handler script.
    • Result: The result of the execution. Click the result to view the specifics of the result details.