Joget Workflow v4 Training - Module 9 - Hash Variable

All Rights Reserved © Joget Inc
Joget Workflow v4
Hash Variable
http://facebook.com/jogetworkflow
http://twitter.com/jogetworkflow
Last Revised on March 2015Joget Inc Internal Use Only

Prerequisites
• General understanding on how to design an App using the
Joget platform (i.e. Process, Form, Datalist, Userview).
Joget Inc Internal Use Only

Content
1. Introduction to Hash Variable
2. List of Hash Variable and its usages
3. Nested Hash Variable

Chapter 1
Introduction to Hash Variable

What is Hash Variable?
• Hash Variable != Workflow Variable
• Hash Variable is a special hash-escaped keyword that can be
used in
– Form Builder
– Datalist Builder
– Userview Builder
– Supported plugin configuration properties
– Activity name in Workflow Designer
– External Form URL when mapping an activity to an external form
to return value of some useful runtime variables from
Workflow Engine

Hash Variable
• Each Hash Variable element has its own prefix. Eg.:
– #date.D-MMM-yyyy#
– #form.leave_applications.name#
– #variable.status#
– #i18n.smtpServer#
• A new Hash Variable (with it’s own unique prefix) can be
built through Joget’s plugin architecture.

Plugin Types
Joget Workflow
Form
Builder
Datalist
Builder
Workflow
Engine
Userview
Builder
- APP -
Form Builder
• Form Element
• Form Permission
• Form Load Binder
• Form Options Binder
• Form Store Binder
• Form Validator
Workflow Engine
• Deadline
• Process Participant
• Process Tool
Datalist Builder
• Datalist Action
• Datalist Binder
• Datalist Column
Formatter
• Datalist Filter Type
Userview Builder
• Userview Menu
• Userview Permission
• Userview Theme
App Level
• Audit Trail
• Hash Variable
System Level
• Directory Manager

Chapter Review
• Brief understanding on the purpose that Hash Variable
serves.

Chapter 2
List of Hash Variables and its
usages

Ever Wonder…
• How to display requestor’s full name in a form?

Ever Wonder…
• How to display requestor’s full name in task / activity
name?

List of Hash variables
• Performer
• Internationalization
• Request Parameter
• Environment Variable
• Current User
• User
• Assignment
• Form
• Workflow Variable
• Date

Performer Hash Variable
• Performer
– To get user information of the performer of an activity.
• #performer.activityDefId.id#,
• #performer.activityDefId.username#,
• #performer.activityDefId.firstName#,
• #performer.activityDefId.lastName#,
• #performer.activityDefId.email#,
• #performer.activityDefId.active#,
• #performer.activityDefId.timeZone#
• Reference:
http://dev.joget.org/community/display/KBv4/Performer+Hash+Variable

Using #performer Hash Variable
#performer.facilities_request.username#

Using #performer Hash Variable in
Form Builder
Hash Variable can be used
in Form Title, Section Title,
Form Element

Workflow Designer
#performer.leave_approval_act1.username#

Plugin Configuration
In Email Plugin, Hash
Variables are supported in
From, To (specific email
address), CC, Subject and
Message fields.

Internationalization Hash Variable
• Internationalization support on application
– Support language localization on application level.
• #i18n.keyName#
• Reference:
http://dev.joget.org/community/display/KBv4/Internationalization+Hash
+Variable

Using #i18n in Userview Builder
• The #i18n Hash Variable retrieves values from the
Message set of the App.
• E.g. Message with key app.hello in 2 locales (en_US,
zh_CN)

Using #i18n in Userview Builder
• With the key defined, the hash variable can be used in the
Userview Builder to dynamically show corresponding value
depending on the user’s locale.

Request Parameter Hash Variable
• Request Parameter
– For accessing request parameters.
• #requestParam.parameterName#
• Reference:
http://dev.joget.org/community/display/KBv4/Request+Parameters+Hash
+Variable

Using #requestParam in Form Builder
• Useful to prepopulate form
field

Environment Variable Hash Variable
• Environment Variable
– Application level environment variable is typically used to store
common or re-usable values such as Email server settings.
• #envVariable.keyName#
• Reference:
http://dev.joget.org/community/display/KBv4/Environment+Variable+Has
h+Variable

Using #envVariable in Email Tool
• Use Environment Variable on Email Tool to ease
maintenance.

Current User Hash Variable
• Current User
– Retrieve currently logged in user information.
• #currentUser.id#,
• #currentUser.username#,
• #currentUser.firstName#,
• #currentUser.lastName#,
• #currentUser.email#,
• #currentUser.active#,
• #currentUser.timeZone#
• Reference:
http://dev.joget.org/community/display/KBv4/Current+User+Hash+Variable

Using #currentUser on Form Builder
• Prepopulate applicant’s name in Form

User Hash Variable
• User
– To get user information based on username.
• #user.username.id#
• #user.username.username#
• #user.username.firstName#
• #user.username.lastName#
• #user.username.email#
• #user.username.active#
• #user.username.timeZone#
• Reference:
http://dev.joget.org/community/display/KBv4/User+Hash+Variable

Using #user Hash Variables
• To get user information based on the username:
– #user.username.id#
– #user.username.username#
– #user.username.firstName#
– #user.username.lastName#
– #user.username.email#
– #user.username.active#
– #user.username.timeZone#
Example:
#user.admin.email#
#user.cat.firstName#

Assignment Hash Variable
• Assignment
– To get workflow activity information of the current assignment.
• #assignment.processId#,
• #assignment.processDefId#,
• #assignment.processName#,
• #assignment.processVersion#,
• #assignment.processRequesterId#,
• #assignment.description#,
• #assignment.activityId#,
• #assignment.activityName#,
• #assignment.activityDefId#,
• #assignment.assigneeId#
• Reference:
http://dev.joget.org/community/display/KBv4/Assignment+Hash+Variable

Using #assignment on Form Builder
• Retrieve current assignment information.

Form Hash Variable
• Form
– To get data from form table.
– #form.formDataTableName.fieldId#
– For examples:
• #form.registration.registeredDate#
• #form.registration.issuedDate#
• #form.registration.issuedDate[0001]#
– To retrieve the field value by specifying a specific record primary key value.
• #form.registration.registeredDate[{variable.recordId}]# //using nested
Hash Variable with curly bracket.
– To achieve the same result like the previous point but by making reference
to another Hash Variable for its record primary key value.

Using #form in Email Tool / Plugin
Configuration

Workflow Variable Hash Variable
• Workflow Variable
– To get the value of a workflow variable.
• #variable.variableName#

Using #variable Hash Variable
• To get the value of a workflow variable:
– #variable.variableName#
Example: #variable.status#

Date Hash Variable
• Date
– To get date time according to a specified format.
– For examples:
• #date.h:mm a# // 12:08 PM #date.EEE, d MMM yyyy h:mm:ss a# // Wed,
4 Jul 2009 12:08:56 PM

Using #date Hash Variables
• To get date time according to a specified format:
– #date.javaSimpleDateFormat# (refer to
http://download.oracle.com/javase/6/docs/api/java/text/Simpl
eDateFormat.html for SimpleDateFormat)
– #date.[DAY/MONTH/YEAR][+/-
]IntegerValue.javaSimpleDateFormat#

• Example: #date.EEE, d MMM yyyy h:mm:ss a#
• Sample Output: Mon, 28 Dec 2009 11:27:26 AM
Java SimpleDateFormat

• Example: #date.DAY+7.EEE, d MMM yyyy h:mm:ss a#
• Sample Output: Mon, 4 Jan 2010 11:27:26 AM
Java SimpleDateFormat+7 days

• Example: #date.MONTH-2.EEE, d MMM yyyy h:mm:ss a#
• Sample Output: Wed, 28 Oct 2009 11:27:26 AM
Java SimpleDateFormat-2 months

• Example: #date.YEAR+1.EEE, d MMM yyyy h:mm:ss a#
• Sample Output: Tue, 28 Dec 2010 11:27:26 AM
Java SimpleDateFormat+1 year

Chapter 3
Nested Hash Variable

Nested Hash Variable
• Hash Variable can be used inside another Hash Variable
to form a Nested Hash Variable.
• The syntax for the inner and subsequent Hash Variables is
wrapped by a pair of curly bracket '{' and '}' instead of the
usual paif of #.
• Example: #prefix.{prefix.variableKey}#
• There is no limit to the depth of the nested variable.

Example of Nested Hash Variable
• #date.{envVariable.dateFormat}#
• #user.{variable.username}.firstName#
• #form.tableChild.field1[{form.tableParent.childId}]#

Chapter Review
• Appreciate the flexibility and convenience brought by the
Hash Variable.
• Able to apply the Hash Variable feature into application
development.

Exercise
1. In “Submit Leave” form, pre-populate the applicant’s
name using hash variable.

Exercise
2. In “Send Rejected Email Notification” Email Tool,
compose the message as follow using hash variable. Go
through the process flow to send out the test email.
Dear [applicant name],
Your application has been [status] due to the following reason:-
[rejected reason]
Thank you.

Exercise
3. In Inbox, instead of just showing “Approve Leave”,
include the applicant’s name to the example as follow:-

Exercise
4. Create a new listing that will only show applications
submitted by the logged in user.
 Create a new Datalist
Add filter criteria in “Extra Filter Condition”.
– Eg. ( e.customProperties.name = 'Cat' )
– Replace ‘Cat’ with the appropriate Hash Variable
 Add the created list into the existing Userview
Reference: http://dev.joget.org/community/display/KBv4/Form+Data+Binder

Exercise
5. Make use of Environment Variable to store commonly
used settings (e.g. Email configuration used in Email Tool
plugin.)
Reference:
http://dev.joget.org/community/display/KBv4/Environment+Variables

Module Review
1. Introduction to Hash Variable
2. List of Hash Variable and its usages
3. Nested Hash Variable

Stay Connected with Joget Workflow
• www.joget.org
• community.joget.org
• twitter.com/jogetworkflow
• facebook.com/jogetworkflow
• youtube.com/jogetworkflow
• slideshare.net/joget

Joget Workflow v4 Training - Module 9 - Hash Variable

More Related Content

What's hot (20)

Viewers also liked (17)

Similar to Joget Workflow v4 Training - Module 9 - Hash Variable (20)

More from Joget Workflow (15)

Recently uploaded (20)

Joget Workflow v4 Training - Module 9 - Hash Variable