Form Store Binder Audit Trail Plugin

Introduction

The Form Store Binder Audit Trail plugin enables you to store modified data as an audit trail, ensuring that any data changes are tracked and logged for security and compliance.

Plugin information

  • Plugin Available: Workflow Form Binder with Audit Trail
  • Compatibility: Joget DX 8

Get started

Prerequisites

  1. Form Store Binder Audit Trail Plugin
    Download the plugin from the Joget Marketplace. Source code: Form Store Binder Audit Trail GitHub Repository.

  2. JSON to Table Formatter Plugin
    Download the plugin from the Joget Marketplace. Source code: JSON to Table Formatter GitHub Repository.

Where to get the plugin

You can download the Form Store Binder Audit Trail Plugin and JSON to Table Formatter Plugin from their GitHub repositories.

How to install

  1. Download the plugin from the GitHub repository or Joget Marketplace.
  2. Log in to your Joget Workflow as an admin.
  3. Navigate to Admin Bar > Settings > Manage Plugins.
  4. Upload the plugin by selecting the downloaded .jar file.
  5. Click Upload.
  6. Ensure to uninstall the old version before uploading the new one.

How to use it

Setting up workflow form binder with audit trail
  1. Before setting up the plugin, create two forms. One form will be used to input data and the other will store the data as an audit trail.
    • Example Input Form (Contract).
    • Example Store Data Form (Trail).
  2. After creating the forms, generate CRUD apps for both forms.
  3. Go to Contract Form > Settings > Advanced > Data > Save Data To and select Workflow Form Binder with Audit Trail.

Configure form update process tool datalist action properties

Save data to (workflow form binder with audit trail)

Textual Data Field: Tampered values will be stored in this field as texts.

Copy Parent Field value to audit trail field
  • Current Form: Parent or main form.
  • From: The form field value wanted to be copied into the audit trail form.
  • To: The form field to store the copied value.
  • Foreign Key: The form field to store parent form ID
  • Tracks Everything: Check this option to track all data tampering.

Other data handling options
  • Handling for Field Workflow Variable: Check the checkbox so the plugin will update the workflow variable based on the form field. This does not apply to grid elements.
  • Handling for Uploaded Files: Check the checkbox if you are using file or image attachments in your form elements. It will store uploaded files to .wflow\app_formuploads based on the form properties table name.

Setting up JSON to table formatter

  1. Go to List - Trail and click the column for History (JSON).
  2. Set the formatter to JSON to Table Formatter.

Field mappings
  • Attribute Name: Name for each attribute.
  • Column Label: The name of each column in the table.
  • Column Inline Style: Column inline styling in CSS.
  • Hide Column: Check the checkbox to hide the column in runtime.
  • Show Unmapped Fields: Check the checkbox to show unmapped fields.
Runtime

Once the plugin is configured, any data changes will be tracked. Here’s the process:

  1. Go to Manage Contract > New, fill in the details and save.
  2. After saving, click the arrow next to the Name value, and the Trail data list will drop down. However, since no changes have been made, no value will be shown yet.
  3. Change the existing data or add new values, then save the form.
  4. View the Trail Data list again to see all the changes made in the data.

Expected outcome

The modified data will be stored as an audit trail, tracking any changes made.

Download plugin

Download sample app

Download the demo app for Form Store Binder Audit Trail Plugin:
Created by Julieth Last modified by Aadrian on Nov 19, 2024