Appendix C: Custom Event Model

The purpose of the Custom Event Model is to provide user customization that remains in place and is bypassed during a solution upgrade. The Predictive Analytics solution supports these models using Business Rules.

Set Up the Custom Event Model

  1. On the Application tab click Dashboards > Dashboard Maintenance Units > XFW Predictive Analytics (PAM) > Files

  2. In the Files folder, click CustomEventHandler_Pam.zip.

  3. In the General (File) pane, click Download File and save the file to an appropriate location.

  4. On the Application tab, click Tools > Load/Extract.

  5. On the Load tab, locate CustomEventHandler_PAM.zip using the Select File icons and click Open.

  6. When the solution's file name appears, click Load to import the business rule.

Integrate Business Rules

After importing the business rule, updating the PAM_EventHandler business rule to integrate with the CustomEvents business rule.

  1. In the General section of the PAM_SolutionHelper script Properties tab, add BR\CustomEvents_[[[[PredictiveAnalytics]]]] to Referenced Assemblies.

  2. In the General section of the PAM_EventHandler script Properties tab, add BR\CustomEvents_[[[[PredictiveAnalytics]]]] to Referenced Assemblies

  3. Comment out line 42 of the PAM_EventHelper business rule.

  4. Uncomment line 43 of the PAM_EventHelper business rule.

    Once the custom event integration is set up, event actions can be defined in the CustomEvents_[[[[PredictiveAnalytics]]]] script.

    IMPORTANT: These events will not be deleted or overridden when upgrading to new versions of Predictive Analytics. However, each time a new version is upgraded, apply these setup steps.

Available Custom Events

Before/After Selection Changed Events

These events run before/after a custom control is clicked.

  • SaveSettings

  • CreateSolutionTables

  • ValidateSetupStepsExecuted

  • Uninstall

  • OnTableEditorOrGridSelection

  • OnComboBoxSelection

  • OnButtonClick

  • OnShowContentPage

Before/After Save Data Events

These events run before/after the save event for a table editor. For example, this can be used to test grid data prior to saving and potentially not allowing data to be saved if a check fails.

  • OnSaveOrUpdateTableEditor