• • Force pop-ups/pages for editing content even if the user does not have required fields to fill out. * *

Description

By default, the Business Flow does not pop up the edit form when the following conditions are met: no required or required values under normal layout, no required and no object under process layout. Enabling this will force the edit form to pop up regardless of whether or not these conditions are met.

# Example of a typical scenario

• • • Scenario 1 * *: data must be confirmed before completion Example: When clicking "Done", an edit form will pop up for double confirmation even if all fields already have values
• • • Scenario 2 * *: Fields must be updated before approval Ex: When the approval amount exceeds the threshold, the form must be opened to fill in the approval comments
• • • Scenario 3 * *: Instructions must be filled in before signing For example: Before adding a signature, you must fill in the reason for adding a signature

Applicable Scenario

• Requires mandatory user confirmation or supplemental data prior to completing tasks/approvals
• There are no required fields under the default layout, but the business needs to pop up the edit before submitting
• Need to ensure that the user reconfirms the data before critical actions

# Applicable Pages

• On task completion/approval action

# Development Ideas

Enhancements can often be broken down into three steps:

1. • • Identify which link to enhance * *

• Determine which action requires a mandatory pop-up form (complete/approve/stamp, etc.)

2. • • Select the appropriate extension event/hook * *

• Mobile: flow.bpm.edit.form.render.before
• Web: bpm.process.render.before

3. • • Access the extension point in the plugin and verify the behavior * *

• Call the forceShowEditForm() method to force the edit form to pop up

DEVELOPMENT WORKFLOW

1. • • Identify requirements scenarios for mandatory forms * *

• Determine which action requires a mandatory pop-up form

2. • • Select an event * *

• Mobile: flow.bpm.edit.form.render.before
• Web: bpm.process.render.before

3. • • Write mandatory form logic * *

   // Examples on mobile
   module.exports = function (context, pluginService, pluginParam) {
       return {
           apply() {
               return [{
                   event: "flow.bpm.edit.form.render.before",
                   functional: async function (context, options) {
                       return Promise.resolve({
                           forceShowEditForm: true
                       });
                   }
               }];
           }
       };
   };
   
   // Web-side example
   module.exports = class Plugins {
       apply() {
           return [{
               event: 'bpm.process.render.before',
               functional: this.bpmProcessRenderBefore.bind(this)
           }];
       }
   
       bpmProcessRenderBefore(api) {
           api.forceShowEditForm();
       }
   };

4. • • Configure Plugins * *

• Associate plugins in process advanced configurations

# Recommended entrance

Caution

1. • • User experience * *: Frequent mandatory pop-up forms can affect the user experience and is recommended for critical operations only
2. • • Form data * *: After the force pop-up, the data filled in by the user will be submitted with the task
3. • • Mandatory with comments * *: Can cooperate with the mandatory function of approval comments to ensure that key information is mandatory