Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Process Enhancement Plugin are is made up of the following plugins:

  1. Process form modifier (New form plugin to add action buttons to the form, such as "Approve" or "Reject", etc. ).
  2. Two process generators (Wizards to auto to auto-generate the datalist, userview, process design and process mappings).
  3. Process list (A new userview menu to display action buttons in the datalist, such as "Approve" or "Reject", etc. ).
  4. Datalist actions (internal to item items 1 and 2 above).


Get Started

...

StepsScreens (Click to view)
  1. Download the plugin from Joget Marketplace and import it into your Joget platform via Manage Plugin (See Figure 1).

  2. Return to All Apps and click on on the Design New App. Provide the app details and click on the Save button.

  3. Click on the Create new form and add two fields:
    1. A hidden field with id = 'status' and Workflow Variable field = 'status' 
    2. A textfield field with id = 'request'

  4. Save your form.

  5. Click on the green button called App Generator then click on the Generate Process - Approval Process (See Figure 2).

  6. Close the form and return to the "Design App" page. You will notice that the App Generator has created the datalist and userview records for you.

  7. Publish your app and click on the Launch button.

  8. Your app is now ready for you.

  9. In the app, click on the Submit Request Form menu. Fill in the "Request Note" and click on the Submit button (See Figure 3).

  10. In the app, click on the Approval menu. You will immediately see something new; the datalist has "Approve, Reject, Clarify, Reassign" buttons below the list. These buttons was were generated by the new Process List userview plugin (See Figure 4).

  11. Now click on the View hyperlink in the Approval datalist.

  12. The form will open and you will again see something new, the form has "Approve, Reject, Clarify, Reassign, Save As Draft, Cancel" buttons. These buttons was were generated by the new Process Form modifier plugin (See Figure 5).

  13. Go ahead to click the the Approve button. You have completed the process flow.

  14. In the app, click on the My Closed Request Form menu to see the completed record.

  15. You can view the generated process flow in "Design App > Processes".

  16. The app includes generated email notification in the "Processes > Map Tools To Plugin" which you can customize anytime.


Figure 1

Figure 2

Figure 3

Figure 4

Figure 5

...

Name

Description

Screens (Click to view)
Custom ID

Item link slug. Optional field.

Info
iconfalse
titleUnique field

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

Figure 6:

Label *Menu label. Mandatory field.
Process *Map to process. Mandatory field.
List *Datalist to load. Mandatory field.
Type *

Each process list menu is like a CRUD menu, but with enhanced features. You can tag the process list menu for various tasks and the plugin will automatically present the action buttons. There are five types of process list:

  • My completedCompleted: Use this type to display completed tasks. My completed Completed belongs to the user who started the process.
  • My in progressIn Progress: Use this type to display submitted tasks. Joget will add the 'Reassign' and 'Withdraw' buttons in the datalist.
  • My participatedParticipated: Use this type to display completed tasks. My participate Participated allows other users to view and input comments in the task form.
  • My withdrawnWithdrawn: Use this type to display withdrawn tasks. My withdrawn belongs to the user who started and then withdrawn the process.
  • Process activityActivity: Use this type to display tasks pending approval or clarification. Joget will add the 'Approve', 'Reject', 'Clarify' and 'Reassign' buttons in the datalist.

...

Name

Description

Screens (Click to view)
Select OrganizationRefine the selections by selecting a an organization.


Figure 9:

Select DepartmentRefine the selections by selecting a department.
Select GroupRefine the selections by selecting a group.
Add Empty OptionIf checked, an empty option will be added to the selections.
Empty Option LabelEmpty option label. Only in use when Add Empty Option is checked.
Label
  • Full Name with Username
  • Username
  • Full Name
Grouping by
  • None
  • Organization
  • Department
  • Grade
Use AJAX for cascade options?

When checked, this allows these fields to dynamically load available options based on the other field value (grouping column) when dealing with with a tremendous amount of selections. Read more at Ajax Cascading Drop-Down List.

Only available when used as an Options Binder. An array "values" is passed to the script automatically. See Bean Shell Programming Guide > Form Ajax Options Binder for example.

Sync Cache IntervalUse this option to cache your selectbox if it has a large number of records. Value The value to activate cache synchronization (in seconds)
Pause sync after idlePause sync if idle more than x seconds

...

Name

Description

Screens (Click to view)

Enable comments?

Check this and the plugin will display a new field for the user to input comments.


Figure 11:

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.

...

Name

Description

Screens (Click to view)

Enable process status?

Check this to display the process status as a percentage. Clicking this icon will open up a workflow chart.


Figure 12:

Show Process Name?

Check this to display the process name.

Show Future Process Activities?

Check this to display the future process activities.

Show Skipped Activities?

Check this to show skipped activities.

Username Display Format

Select the choice of username display in the process chart. The options are:

  • Username
  • Name
  • Name (Username)

...

Name

Description

Screens (Click to view)
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' your your new app. For example, if your appId is "myFavApp", the new table name in the database is "app_fd_myFavApp_pd".


Figure 13:

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 & labelEnter 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 value of "Withdrawn", input this information into the 'Custom value' and 'Custom label' property fields respectively.

...

Name

Description

Screens (Click to view)

Back Button Label

You can change the back button label. Default The default is "Back".


Figure 14:

Save Button Label

You can change the save button label. Default The default is "Save".

Custom Header

Custom Header in HTML to show when editing an individual record in a form.

Custom Footer

Custom Footer in HTML to show when editing an individual record in a form. 

...

NameDescriptionScreens (Click to view)

Show Number of Rows In Menu

Show Number of Rows In Menu.

Info
iconfalse
titlePerformance Warning

Additional An additional query will be performed to return record count every time the Userview loads.


Figure 15:

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.

Link to edit the form will default to 'View' but you can change the link name here.

Custom Header

Custom Header in HTML to show above the listing.
Custom FooterCustom Footer in HTML to show below the listing.

...

Name

Description

Screens (Click to view)
Execute Process Action in Background?Click on the checkbox to set the assignment complete or run process to start in a separate thread. With this option enabled, the form will not wait until all the tools have been executed to return to the datalist.
Readonly
Set all sections as readonly?

Click on the checkbox to set all section fields as readonly.


Figure 18: More Settings



Figure 19: Plugin Configuration

Clarification

Enable clarification of selected activity?

Click on the checkbox to configure the following:

  • Clarification Activity
  • Clarify Button Label
  • Skip Validation?
  • Execute Tool After Return to Clarification Activity
  • Tooltip Message
  • Confirmation Message

Reassignment

Enable reassignment?

Click on the checkbox to allow reassignment. If option is enabled, the following fields are shownconfigure reassignment:

  • Reassignment activity
  • Reassignment user options binder
  • Reassign button label
  • Skip Validation?
  • Execute tool after reassignment
  • Reassignment Update Assignee Field
  • Tooltip message

Process Withdrawal

Enable withdraw process?

Click on the checkbox to configure the withdraw process:

  • Execute tool after process withdrawal
  • Withdraw button label
  • Tooltip message
  • Confirmation message

Approval

Replace complete button with approve & reject button?

Click on the checkbox to configure the approval process:

  • Multi approval: for Disabled, All Assignee Approved & Any required number of assignee approved.
  • Approve button label.
  • Reject button label.
  • Tooltip message (Approve).
  • Confirmation message (Approve).
  • Tooltip message (Reject).
  • Confirmation message (Reject).

Comments

Enable comments?

Click the checkbox to configure comments:

  • Comments display mode
  • Exclude comments from activities
  • Show Activity Name?
  • Status Column Width (Default: 50%)
  • Number of Latest Comments Show by Default
  • Disabled Adding New Comment?
  • Comment Field Type
  • Set Comment Field As Mandatory?
  • Enable Attachment Field?

Process Status

Enable process status?

Click the checkbox to configure the process status:

  • Show Process Name?
  • Show Future Process Activities?
  • Show Skipped Activities?
  • Username Display Format

Data

Process data table

Define the process data table name or leave as default. Best not to remove the "{appId}" marker string.
Update workflow variable & form data?

Click the checkbox to configure the workflow variable & form data update:

  • Workflow variable to store status: Key in the workflow variable id that will store the process status. 
  • Update draft status to workflow variable & form data: Click the checkbox to update draft status to workflow variable & form data.
  • Parent form field id to store status: Key in the parent form field id to store status
  • Custom process status value & label. Set the custom value and label for:
    • Approved
    • Rejected
    • Clarification
    • Reassignment
    • Withdrawal
    • Completed
    • Draft

...