Versions Compared

Old Version 84

changes.mady.by.user Osamah Abdullah

Saved on

compared with

New Version 85

changes.mady.by.user Osamah Abdullah

Saved on

Key

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

...

Name

Description

Custom ID

Item link slug. Optional field.

Info
iconfalse
titleUnique field

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

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 Completed: Use this type to display completed tasks. My Completed belongs to the user who started the process.
  • My In Progress: Use this type to display submitted tasks. Joget will add the 'Reassign' and 'Withdraw' buttons in the datalist.
  • My Participated: Use this type to display completed tasks. My Participated allows other users to view and input comments in the task form.
  • My Withdrawn: Use this type to display withdrawn tasks. My withdrawn belongs to the user who started and then withdrawn the process.
  • Process Activity: Use this type to display tasks pending approval or clarification. Joget will add the 'Approve', 'Reject', 'Clarify' and 'Reassign' buttons in the datalist.

Image Modified

Figure 6 


Process Activity

Name

Description

Activity *

Select the process activity that you designed for this task.
Assignment View Custom HeaderCustom Header in HTML to show when editing an individual record in a form.
Assignment View Custom FooterCustom Footer in HTML to show when editing an individual record in a form.


Image Modified

Figure 7


My In Progress

Name

Description

Enable reassignment?

Check to allow the approving user to reassign the task.

Reassignment activity *

Select the process activity that you designed for task approval.
Reassignment user options binder *Select which binder to use to pop up the username to reassign.
Reassign button labelWill default to 'Reassign' if left blank.

Enable withdraw process?

Check to allow the request to withdraw the task.

Execute tool after process withdrawal

Select the process activity that you designed for task withdrawal.

Withdraw button label

Will default to 'Withdraw' if left blank.


Image Modified

Figure 8


Reassignment user options binder (User Options Binder)

Name

Description

Select OrganizationRefine the selections by selecting an organization.
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 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. The value to activate cache synchronization (in seconds)
Pause sync after idlePause sync if idle more than x seconds

Image Modified

Figure 9

UI Form Properties

Name

Description

FormChange this property to open another form
Created by field id *Default to 'createdBy' to store the username
Set all sections as readonly?Check as readonly to prevent editing.
Display readonly as label?Check to show readonly fields as labels.


Image Modified

Figure 10


Comments

Name

Description

Enable comments?

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

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.


Image Modified
Figure 11


Process Status

Name

Description

Enable process status?

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

Show Process Name?

Check this to display the process name.

Show Future Process Activities?

Check this to display 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)

Image Modified
Figure 12


Data

Name

Description

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 new app. For example, if your appId is "myFavApp", the new table name in the database is "app_fd_myFavApp_pd".

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.


Image Modified
Figure 13


UI

Name

Description

Back Button Label

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

Save Button Label

You can change the save button label. 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. 

Image Modified
Figure 14

UI List Properties

NameDescription

Show Number of Rows In Menu

Show Number of Rows In Menu.

Info
iconfalse
titlePerformance Warning

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

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.


Image Modified
Figure 15

Advance Properties

...

Name

Description412px

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.


Image Modified

Figure 16


PWA Offline Settings

...

Name

Description

Enable cache for offline supportCheck this to enable caching for offline support, usually set for use on mobile browsers.
Cache all datalist links in first pageCheck this to enable caching for all datalist links, usually set for use on mobile browsers.
Cache list actions (Non post action)Check this to enable caching for datalist action buttons, usually set for use on mobile browsers.

Image Modified

Figure 17

Map Activities to Forms - More Settings

...

Name

Description

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.

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 configure 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


Image Modified


Figure 18: More Settings


Image Modified
Figure 19: Plugin Configuration

...