Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata


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:

StepsScreens (Click To View)

Steps to use this element

  1. Start the Joget server and open the App Center.

  2. Login as admin and click on Design New App (See Figure 1) or click on any of your existing applications.

  3. For a new application, fill up the App ID with camel case, App Name, and click on Save button. (See Figure 2)

  4. Create a New Form, fill up Form ID with camel case, Form Name, and click on Save button. (See Figure 3)

  5. Drag and drop a few text fields and Save the Form.
  6. Click on Generate App on the top right corner, tick GENERATE PROCESS - APPROVAL PROCESS, and click Generate.

  7. Edit the userview and drag in a List element and a Process Status element into any category. (See Figure 4)

  8. Edit the List element to display your only datalist in the app. (In this case, it is List - Basic Form)

  9. Edit the Process Status and add a custom ID and configure the View Permission. (See Figure 5). Take note of how the Process Status menu is reading the "Record Id" - we are using request parameter hash variable.

  10. Next, configure the datalist and add a hyperlink to the details. (See Figure 6)

  11. After that, configure the hyperlink and save the datalist. (See Figure 7). This is where we link the Process Status menu to the specific process instance record from the list by passing over the request parameter "id".

  12. You can test the Process Status after you run a process in the userview and click the hyperlink in the datalist to view the process status.

Figure 1

Figure 2

Figure 3

Figure 4

Figure 5

Figure 6

Figure 7


Process Status Properties

Configure Process Status

NameDescriptionScreen (Click to view)
idMenu element unique id. Userview will use this id in the URL for the menu if the Custom ID is empty.

Figure 1: Process Status Properties



Custom ID

Item link slug. Optional field.

Unique field

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

LabelMenu label. Mandatory field.
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 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

NameDescriptionScreen (Click to view)
Custom HeaderCustom Header in HTML.

Figure 2: UI Properties

Custom FooterCustom 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 ActivitiesClick checkbox to show future process activities.
Show Skipped ActivitiesClick 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

You can configure the Performance settings in this Userview Element which allows one to cache existing content for improved performance and loading speed. Read more at Performance Improvement with Userview Caching.



  • No labels