Process Enhancement Plugin

Introduction

The Process Enhancement Plugin is a suite of four plugins designed for the Joget DX Enterprise edition. It automatically generates approval and rejection buttons on datalist and form screens.

Plugin information

• Plugin available: Process Enhancement Plugin
• Contains:
  • Process Form Modifier (adds action buttons like Approve or Reject)
  • Two Process Generators (auto-generate the datalist, userview, process design, and mappings)
  • Process List (displays action buttons like Approve or Reject)
  • Datalist Actions (for the items above)

Get started

Where to get the plugin

Download the Process Enhancement Plugin from the Joget Marketplace.

How to install

1. Download the plugin JAR file from the releases page.
2. Go to Settings > Manage Plugins > Upload Plugin.
3. Once uploaded, the plugin will be available in your Joget environment.

How to use it

The easiest way to see how the Process Enhancement works is to create a new form and use the App Generator > Generate Process - Approval Process button in the form to automatically build the app. Follow the steps below:

1. Go to All Apps and click Design New App.
2. Provide app details and click the Save button.
3. Create a form with two fields:
   1. Hidden field (id = status, Workflow Variable field = status).
   2. Text field (id = request).
4. Use App Generator > Generate Process - Approval Process to automatically build the app.
   
   Close the form and return to the Design App page. The App Generator has created the datalist and userview records for you.
   
5. Publish the app and click the Launch button.
6. In the app, click the Submit Request Form menu.
7. Fill in the Request Note and click Submit.
   
8. In the Approval menu, the data list could include buttons like Approve, Reject, Clarify, and Reassign.  The new Process List userview plugin generated these buttons.
9. Click the View link in the Approval datalist.
   
   
10.  A new form will open, and you will see the Approve, Reject, Clarify, Reassign, Save As Draft, and Cancel buttons generated by the new Process Form modifier plugin.
11. Click Approve to complete the process.
    
    
12. Click the app's My Closed Request Form menu to view the completed record.
13. You can view the generated process flow in Design App > Processes.
14. The app includes generated email notifications in the Processes > Map Tools To Plugin, which you can customize anytime.

Configure process list properties

Configure the plugin properties for the Process List, including labels, mapping to processes, and List settings.

Fields to configure:

• Custom ID: Optional field for the item link slug, must be unique across all Userview Menus.
• Label: Mandatory field for menu label.
• Process: Mandatory field to map the process.
• List: Mandatory field for selecting the Datalist to load.
• Type: Choose from five types of process lists:
  • My Completed: Shows completed tasks started by the user.
  • My In Progress: Shows submitted tasks with 'Reassign' and 'Withdraw' buttons.
  • My Participated: Shows completed tasks, allowing users to comment.
  • My Withdrawn: Shows tasks withdrawn by the user.
  • Process Activity: Shows tasks awaiting approval or clarification with 'Approve,' 'Reject,' 'Clarify,' and 'Reassign' buttons.

Process activity

Fields to configure:

• Activity: Select the process activity designed for this task.
• Assignment View Custom Header: Custom HTML header for individual record editing.
• Assignment View Custom Footer: Custom HTML footer for individual record editing.

My in progress

Fields to configure:

• Enable reassignment?: Check to allow the approving user to reassign the task.
• Reassignment activity: Select the process activity that you designed for task approval.
• Reassignment user options binder: Select which binder to use to pop up the username to reassign.
• Reassign button label: Defaults to 'Reassign if left blank.
• Enable withdraw process?: Check to allow the request to withdraw the task.
• Execute tool after process withdrawal: Select the activity you designed for task withdrawal.
• Withdraw button label: Defaults to Withdraw if left blank.

Reassignment user options binder

There are options for selecting organization, department, group, and others, with features like grouping by organization, department, or grade, AJAX for cascading options, and cache sync options.

Fields to configure:

• Select Organization: Refine the selections by selecting an organization.
• Select Department: Refine the selections by selecting a department.
• Select Group: Refine the selections by selecting a group.
• Add Empty Option: If checked, an empty option will be added to the selections.
• Empty Option Label: Define the label for the empty option. Only used when the Add Empty Option is checked.
• Label: Options for how to display user information in the select dropdown:
  • Full Name with Username
  • Username
  • Full Name
• Grouping by: Group options by:
  • None
  • Organization
  • Department
  • Grade
• Use AJAX for cascade options?:
  • If checked, dynamically loads available options based on the selected value in other fields (useful for handling large datasets). For more information, see the documentation for the Dynamic Cascade Drop-Downs.
  • Only available when used as an Options Binder. Automatically passes an array values to the script.
  • For examples, see the Bean Shell Programming Guide > Form Ajax Options Binder.
• Sync Cache Interval: Cache synchronization interval for select boxes with many records in seconds.
• Pause sync after idle: This option pauses cache synchronization if the user is idle for more than the specified number of seconds.

UI (Form)

Fields to configure:

• Form: Change this property to open another form.
• Created by field id: Defaults to createdBy to store the username.
• Set all sections as readonly?: Check as readonly to prevent editing.
• Display readonly as label?: Check to show readonly fields as labels.

Comments

Fields to configure:

• Enable comments?: Check this option, and the plugin will display a new field for the user to input comments.
• Show activity name?: Check to display the activity name in the comment trail.
• Number of latest comments show by default: Defaults to 5 lines of comment trail per pagination.
• Disabled adding new comment?: Check to disable new comments.

Process status

Fields to configure:

• Enable process status?: Check this to display the process status as a percentage. Clicking this icon will open up a workflow chart.
• Show Process Name?: Check this to display the process name.
• Show Future Process Activities?: Check this to display future process activities.
• Show Skipped Activities?: Check this to show skipped activities.
• Username Display Format: Select the username display option in the process chart. The options are:
  • Username
  • Name
  • Name (Username)

Data

Fields to configure:

• Process data table: This property defines the new database table name to use when creating a new child table to store the activity comments entered by the users. Defaults to {appId}_pd. where appId is the ID of your new app. For example, if your appId is myFavApp, the new table name in the database is app_fd_myFavApp_pd.
• Update workflow variable & form data?: Check this to customize the workflow variable & form data (see the following fields).
• Workflow variable to store status: Enter the workflow variable id to store the status value.
• Parent form field id to store status: Enter the form field ID to store the status value.
• Custom process status value & label: Enter the Custom value and Custom label for the reassignment and withdrawal actions. For example, in the withdrawal action, to save into the status field the label of Requester Withdrawn and the value of Withdrawn, input this information into the Custom value and Custom label property fields, respectively.

UI

Fields to configure:

• Back Button Label: Customize the back button label (default is Back).
• Save Button Label: Customize the save button label (default is Save).
• Custom Header: Custom HTML header for individual record editing.
• Custom Footer: Custom HTML footer for individual record editing.

UI (list)

Fields to configure:

• Show Number of Rows In Menu: Displays the number of rows in the menu.
  
  Performance Warning
  An additional query will be performed to return the record count every time the UI loads.
• Button Position: 
  • Top Left
  • Top Right
  • Bottom Left
  • Bottom Right
  • Top Left & Bottom Left
  • Top Right & Bottom Right
• Selection Type: 
  • Multiple
  • Single
• Selector Position:
  • Left
  • Right
  • Both let & right
  • No
• View form link label: Optional field to customize the form view link label.
• Custom Header: Custom Header in HTML to show above the listing.
• Custom Footer: Custom Footer in HTML to show below the listing.

Advanced

Field to configure:

• Userview Key Name: Define a column to pre-filter the datalist using the userview key.

Performance & offline

Fields to configure:

Cache settings

• Scope: Caching options are:
  • None: no caching.
  • Application: Cache content by application where all users will see the same content.
  • User: Cache by username
• Duration (s): Duration in seconds to cache content (defaults to 20 seconds).

PWA offline settings

• Enable cache for offline support: Check this to enable caching for offline support, which is usually set for mobile browsers.
• Cache all datalist links in first page: Check this to enable caching for all datalist links, usually set for use on mobile browsers.
• Cache list actions (Non post action): Check this to enable caching for datalist action buttons, usually set for mobile browsers.

Map activities to forms

If you use the Process List plugin in your Userview, you can perform additional configuration of the menu in Map Activities to Forms > More Settings:

Uninstalling the plugin

The following are the individual plugins in the Process Enhancements bundle, which you can uninstall from Admin Bar > Settings > Manage Plugins if you do not want to use them in your Joget platform:

• Generate Process - Approval Process
• Generate Process - Assignment Process
• Assignment Datalist Action
• Assignment Form Actions
• Process List

Download plugin

• Process Enhancement Plugin DX

Download sample app