Audit Trail Plugin

Usages

• The Audit Trail Plugin is triggered after an audit trail event to provide extra processing capabilities (e.g., capturing reporting data or user notification).

• Audit Trail Plugin can be set in Plugin Default Properties - Audit Trail.

• A usable Audit Trail Plugin must extend org.joget.plugin.base.DefaultAuditTrailPlugin abstract class.

Abstract Class

org.joget.plugin.base.DefaultAuditTrailPlugin

• Under wflow-plugin-base module

• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.

• Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.

• A base abstract class to develop a Audit Trail Plugin. 

Method Detail

Abstract Methods

execute

public abstract java.lang.Object execute(java.util.Map props)

To execute the extra processing based on Audit Trail Event.

Sample Usage

   public Object execute(Map props) {
        AuditTrail auditTrail = (AuditTrail) props.get("auditTrail");
        if (auditTrail != null && auditTrail.getClazz().startsWith("org.joget.apps.form.dao.FormDataDaoImpl")) {
            String method = auditTrail.getMethod();
            
            if (method.equals("load")) {
                Class[] paramTypes = auditTrail.getParamTypes();
                Object[] params = auditTrail.getArgs();
                Object returnObject = auditTrail.getReturnObject();
                //do something
            }
        }
        return null;
    }

Audit Trail Event

Workflow Process Related Events

Form Related Events

Please refer to FormDataDao for extra Information.

Organization Chart Related Events

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• Guideline for Developing a Plugin
• How to develop a Slack Notification plugin

Related Community Plugins

• Process Data Collector

  org.joget.apps.app.lib.ProcessDataCollectorAuditTrail (wflow-core)

• User Notification

  
  
  
  org.joget.apps.app.lib.UserNotificationAuditTrail (wflow-core)