Introduction

The Process Status allows one to inspect the state and trail of a process instance.

Get Started

The easiest way to see how does the Process Status Menu works is to first create a new process. Here are the steps:

1. Start your Joget Server, Log in as administrator then click on Design New App.

Figure 1


2. Fill up the App details as shown. (See Figure 2)

Figure 2


3. Create a new Form, and fill up its details as shown then Save the Form. (See Figure 3) 

Figure 3


4. Fill up the Form with a Text field, fill up its details as shown and Save the Form. (See Figure 4)

Figure 4


5. Generate an Approval Process. (Figure 5)

Figure 5


6. From the List Builder, Launch the automatically generated List. (See Figure 6)

Figure 6


7. Drag a Hyperlink in to the Row action part of the List (top right of the canvas). (See Figure 7) 

Figure 7


8. Configure the Hyperlink as shown in the image, then Save the List. (See Figure 8)

Figure 8


9. Navigate to the UI Builder, then click on the automatically generated UI to edit it. (See Figure 9). 

Figure 9


10. Drag a List UI Element and a Process Status UI Element to the Home Category. (See Figure 10 & 11)

Figure 10


Figure 11


11. Configure the Process Status and List UI Elements as shown. (See Figure 12 & 13).

Figure 12

Figure 13


Info

For a more in-depth tutorial on using the Process Status UI Element, Check out this article.


Process Status Properties

Configure Process Status

Figure 14: Process Status Properties

NameDescription
LabelMenu label. Mandatory field.
Menu ID

Item link slug. Optional field.

Unique field

Value defined here must be unique to the rest of the UI Menus as the first matching name will be called upon.

Type

The type of visual format, either Path (default) or Chart.

Example Path:

Example Chart:


Record ID
  • Record Id or Process Instance Id. Please use the Request Parameter Hash variable if want to retrieve this value from URL, for example "#requestParam.id#".
  • Mandatory field.


Example

By using the request parameter hash variable, we can define the record ID to seek for.

Record ID: #requestParam.id#

View Permission

Determines who can access the record's information.

  • Process requester
  • Participants of the process
  • Admin users
  • Group
  • Department

At least one option must be selected.

UI

Figure 15: UI Properties

NameDescription

Custom Header

Custom Header in HTML.

Custom Footer

Custom Footer in HTML.

Show Process Name?

If checked, the process name will be generated at the top of the resultant graph. Optional.

Show Future Process Activities

Click the checkbox to show future process activities.

Show Skipped Activities

Click the checkbox to show skipped activities.

Username Display Format

  • Name

  • Username

  • Name (Username)

Event Click Callback (Javascript) 

Callback variable "activity" containing information of activity and process.

Performance & Offline 

Figure 16: Process Status Properties - Performance & Offline Settings 


Name

Description

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 if applicable.

Read more at Performance Improvement with UI Caching.

PWA Offline Settings

Note: PWA Offline support is dependent on the theme used.

Name

Description

Enable cache for offline supportCheck this to enable caching for offline support, usually set for use on mobile browsers.

Read Progressive Web Application (PWA) for more information.

  • No labels