Run Process Menu

The Run Process Menu in Joget allows users to initiate a process instance directly from the UI, providing flexibility and control over process management within your application.

Configure run process

To configure Run Process properties, in UI Builder, drag and drop the Run Process element onto the canvas and click on it.

When adding Run Process, you will see the following fields available for configuration:

• Label: This is the menu label displayed for the Manage Permission Menu. It's a mandatory field, and you can add Font Awesome Icons to your menu labels.
• Menu ID: Item link slug. Optional field.
  
  Unique field
  The value defined here must be unique to the rest of the UI Menus, as the first matching name will be called upon.
• Process: Select the process to start. This field is mandatory.
• Run process without confirmation screen?: If checked, the user will be prompted before proceeding to start the process instance.
• Show in popup dialog?: If checked, the user will interact with a popup dialog to initiate the process instance.
• Submit Button Label: Label to be displayed on the submit button.

Redirection

The "Redirection" settings in the Run Process Menu allow you to define what happens after a process instance is started. You can specify a message to display to the user, the URL to redirect to, and the window target for the redirection. These settings help create a seamless user experience by guiding users to the next appropriate step or confirming their actions.

Fields to Configure:

• Message shown after process started: Display a message confirming the process has been started.
• Action to Perform After Form Saved: Specify actions after the form associated with the process instance is saved.
  • Redirection 
    • URL redirect after process started: When the user clicks Complete or Save As Draft form button, Joget will redirect to this URL value if the activity/form is the first activity in the process flow.
    • Redirect Target on Form Submission: Define where the redirection target should be.
      • Top Window
      • Parent Window
      • Current Window
    • Field ID for URL Redirect Value Passover: Field ID of one of the form elements in the preceding form to retrieve the value from.
    • Field Value Passover Method:
      • Append to URL
      • As URL Request Parameter
    • Request Parameter Name: Parameter name to be added to the URL redirect.
  • Reload Window
    
    • Reload Target: 
      • Parent Frame
      • Top Window

Advanced

The Advanced settings in the Run Process Menu provide additional configuration options for advanced use cases. This includes defining a UI Key Name, which allows you to pre-populate form elements with specific values based on the UI key. These settings offer greater flexibility and control over how the process initiation interacts with other parts of the application.

Field to Configure:

• UI Key Name: If defined, the corresponding form element defined here will be populated with the UI key value.

Performance & offline

The Performance & Offline settings in the Run Process Menu allow you to optimize performance and enable offline support. Configuring cache settings can improve load times and ensure a smoother user experience, even in environments with limited connectivity. These settings are crucial for maintaining efficiency and reliability in your application.

Cache settings

The Cache Settings in the Run Process Menu help manage how content is cached to improve performance. 

Fields to Configure:

• Scope:
  Options include 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 if applicable.

For more information, see Performance Improvement with UI Caching.

PWA offline settings

The PWA Offline Settings in the Run Process Menu enable offline support by caching content for mobile browsers. This ensures that users can continue interacting with the application without an active internet connection. Configuring these settings enhances the user experience, especially for mobile users, by providing uninterrupted access to the application's features.

Field to Configure:

• Enable cache for offline support: Enable caching for offline support. This is usually set for mobile browsers. See Progressive Web Application (PWA) documentation for more details.