What is Hash Variable?

Definition

Hash Variables gives users greater flexibility and freedom in accessing useful information or relevant run-time values from the system.

A 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 the value of some useful runtime variables from Joget components.

To conveniently access the list of all hash variables available, use shortcut combination Ctrl-Shift-3 in any of the components above.

Download the tutorial app on Hash Variables from Joget Workflow Marketplace to learn more about Hash Variable.

Nested Hash Variable

A Hash Variable can be used inside another Hash Variable to form a Nested Hash Variable.

The syntax for the inner Hash Variable is wrapped by a pair of {curly bracket}.

Syntax / Format

Here's some examples:

Example

Escaping the Resultant Hash Variable

The parsed/returned Hash Variable may cause incompatibility with the current context/environment such as syntax error in a script.

Therefore, one may pass in additional parameters into the hash variable declared to escape certain characters.

Before ending a hash variable with a hash "#", add a question mark character "?" followed by the required format. You may include multiple by defining semicolon ";" separated values.

regex - Used to escape regular expression special characters
json - Used to escape JSON special characters
javascript - Used to escape Javascript special characters
html - Used to escape HTML special characters
xml - Used to escape XML special characters
java - Used to escape Java special characters
sql - Used to escape SQL special characters
url - Used to escape URL special characters
nl2br - Used to convert new line character to <br> HTML tag
separator(SEPARATOR_CHARS) - Used to change the default separator ";" to the SEPARATOR_CHARS. eg. ?separator(, ) resulted "abc, def" instead of "abc;def".

Example

New Feature

nl2br and separator are new features in Joget Workflow v6.

List of Hash Variables

Workflow Assignment Hash Variable

New

New attributes added in Joget Workflow v6.

processDefIdWithoutVersion
appId

Name	Description
Prefix	assignment
Description	To get workflow activity information of the current assignment.
Attributes	#assignment.processId# #assignment.processDefId# #assignment.processDefIdWithoutVersion# #assignment.processName# #assignment.processVersion# #assignment.processRequesterId# #assignment.appId# #assignment.activityId# #assignment.activityName# #assignment.activityDefId# #assignment.assigneeId#
Scope of Use	Elements within and part of a Process. Activity Name. Form mapped as part of process activity mapping. Email Tool configuration as part of process tool mapping.
Sample Attributes	To display the assignee's name: #user.{assignment.assigneeId}.firstName# #user.{assignment.assigneeId}.lastName#

Workflow Process Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	process
Description	To retrieve information of a workflow process instance.
Attributes	#process.appId# #process.processId# #process.processDefId# #process.processDefIdWithoutVersion# #process.processName# #process.processVersion# #process.processRequesterId# #process.state# #process.startedTime# #process.limit# #process.due# #process.delay# #process.delayInSeconds# #process.finishTime# #process.timeConsumingFromDateStarted# #process.timeConsumingFromDateStartedInSeconds# #process.activityInst.ACTIVITY_DEF_ID.instanceId# #process.activityInst.ACTIVITY_DEF_ID.name# #process.activityInst.ACTIVITY_DEF_ID.status# #process.activityInst.ACTIVITY_DEF_ID.state# #process.activityInst.ACTIVITY_DEF_ID.type# #process.activityInst.ACTIVITY_DEF_ID.startedTime# #process.activityInst.ACTIVITY_DEF_ID.limit# #process.activityInst.ACTIVITY_DEF_ID.limitInSeconds# #process.activityInst.ACTIVITY_DEF_ID.due# #process.activityInst.ACTIVITY_DEF_ID.delay# #process.activityInst.ACTIVITY_DEF_ID.delayInSeconds# #process.activityInst.ACTIVITY_DEF_ID.finishTime# #process.activityInst.ACTIVITY_DEF_ID.timeConsumingFromDateStarted# #process.activityInst.ACTIVITY_DEF_ID.timeConsumingFromDateStartedInSeconds# #process.activityInst.ACTIVITY_DEF_ID.performer# #process.activityInst.ACTIVITY_DEF_ID.performerUser# #process.activityInst.ACTIVITY_DEF_ID.assignmentUsers# #process.appId[PROCESS_INSTANCE_ID]# #process.processDefId[PROCESS_INSTANCE_ID]# #process.processDefIdWithoutVersion[PROCESS_INSTANCE_ID]# #process.processName[PROCESS_INSTANCE_ID]# #process.processVersion[PROCESS_INSTANCE_ID]# #process.processRequesterId[PROCESS_INSTANCE_ID]# #process.startedTime[PROCESS_INSTANCE_ID]# #process.limit[PROCESS_INSTANCE_ID]# #process.due[PROCESS_INSTANCE_ID]# #process.delay[PROCESS_INSTANCE_ID]# #process.delayInSeconds[PROCESS_INSTANCE_ID]# #process.finishTime[PROCESS_INSTANCE_ID]# #process.timeConsumingFromDateStarted[PROCESS_INSTANCE_ID]# #process.timeConsumingFromDateStartedInSeconds[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.instanceId[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.name[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.status[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.state[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.type[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.startedTime[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.limit[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.limitInSeconds[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.due[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.delay[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.delayInSeconds[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.finishTime[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.timeConsumingFromDateStarted[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.timeConsumingFromDateStartedInSeconds[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.performer[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.performerUser[PROCESS_INSTANCE_ID]# #process.activityInst.ACTIVITY_DEF_ID.assignmentUsers[PROCESS_INSTANCE_ID]#
Scope of Use	Elements within and part of a Process. Activity Name. Form mapped as part of process activity mapping. Email Tool configuration as part of process tool mapping.
Sample Attributes	To display the performer username of an activity instance of a process instance: #process.activityInst.assign.performerUser[{assingment.processId}]#

Current User Hash Variable

Name	Description
Prefix	currentUser
Description	To retrieve currently logged in user information.
Attributes	#currentUser.id# #currentUser.username# #currentUser.firstName# #currentUser.lastName# #currentUser.email# #currentUser.active# #currentUser.timeZone# In Joget Enterprise edition, these additional attributes are available:- User Meta #currentUser.meta.KEY# To read additional user meta data stored in dir_user_meta table. Example: #currentUser.meta.duration#. New Feature This is a new feature in Joget Workflow v6. Organization #currentUser.organization.id# #currentUser.organization.name# #currentUser.organization.description# Department #currentUser.department.id# #currentUser.department.name# #currentUser.department.description# #currentUser.department.treeStructure# Grade #currentUser.grade.id# #currentUser.grade.name# #currentUser.grade.description# #currentUser.grade.organizationId# HOD #currentUser.hod.username# #currentUser.hod.firstName# #currentUser.hod.lastName# #currentUser.hod.email# #currentUser.hod.active# #currentUser.hod.timeZone# Group #currentUser.groups.id# #currentUser.groups.name# Employment #currentUser.employee.code# #currentUser.employee.jobTitle# #currentUser.employee.isHod# Department HOD #currentUser.department.hod.username# #currentUser.department.hod.firstName# #currentUser.department.hod.lastName# #currentUser.department.hod.email# #currentUser.department.hod.active# #currentUser.department.hod.timeZone#
Scope of Use	All components within the App.

Date Hash Variable

Name	Description
Prefix	date
Description	To get date time according to a specified format. Localization In Joget Workflow v5, the returned value would follow current logged in user's timezone. If user's information is not available, then it will use server's timezone.
Attributes	#date.dateFormat# #date.dateUnit[+-]integerValue.dateFormat# Options dateFormat In Java date format; e.g., yyyy-MM-dd for 2011-06-01 dateUnit YEAR MONTH DAY integerValue Numeric integer value. E.g. 10 #date.DATE_FORMAT_TO[INPUT_DATE_VALUE \| INPUT_VALUE_FORMAT]# #date.dateUnit[+-]integerValue.DATE_FORMAT_TO[INPUT_DATE_VALUE \| INPUT_VALUE_FORMAT]# INPUT_DATE_VALUE accepts any date value and even nested hash variables, e.g: form data hash variable. See example in sample attributes below. INPUT_VALUE_FORMAT is the INPUT_DATE_VALUE original format. DATE_FORMAT_TO defines the format to change to. New Feature This is a new feature in Joget Workflow v6.
Scope of Use	All components within the App.
Sample Attributes	#date.h:mm a# // shows current time of 12:08 PM #date.EEE,d MMM yyyy h:mm:ss a# // shows current date time of Wed, 4 Jul 2014 12:08:56 PM #date.DAY+7.EEE,d MMM yyyy h:mm:ss a# // Add 7 days on top of current date time - Wed, 11 Jul 2014 12:08:56 PM #date.DAY-1.EEE,d MMM yyyy h:mm:ss a# // Minus 1 days on top of current date time - Wed, 3 Jul 2014 12:08:56 PM #date.dd-MM-yyyy[{form.j_expense_claim.title}\|yyyy-MM-dd]# // Retrieves date from j_expense_claim table, form field title, changes its origin format of yyyy-MM-dd to dd-MM-yyyy.

Environment Variable Hash Variable

Name	Description
Prefix	envVariable
Description	To retrieve Environment Variable value. Learn more about Environment Variables .
Attributes	#envVariable. keyName #
Scope of Use	Anywhere within the Joget app itself. (i.e. Process, Process Tool, Form, List, Userview)
Sample Attributes	`#envVariable.smtpServer#` `#envVariable.smtpPort#`

Form Data Hash Variable

Name	Description
Prefix	form
Description	To get field value from form table.
Attributes	#form. tableName . fieldId # #form. tableName . fieldId [recordId]# (Available in 3.1 and above)
Scope of Use	In a Process Tool part of a Process. In a Form. In a process design.
Sample Attributes	`#form.registration.registeredDate# //will use the current record ID` `#form.registration.registeredDate[` `0001` `]# //0001 is the record ID to seek for` `#form.registration.registeredDate[{variable.recordId}]#` `//using nested Hash Variable with curly bracket.`

Form Binder Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	binder
Description	To get field value or field value label from the binder of a form via its form definition id . The '*binder' prefix retrieves the field value, while the 'binder.options' prefix retrieves the lookup field (eg. select box, checkbox & radio button) option label. The field value* or field value label can also be obtained from other apps by including the APP_ID, else it uses the current app context. By providing the PRIMARY_KEY argument, field value or field value label from a different record can be retrieved, else data from the current record id is retrieved instead.
Attributes	#binder.APP_ID.FORM_DEF_ID.FIELD_ID# #binder.APP_ID.FORM_DEF_ID.FIELD_ID[PRIMARY_KEY]# #binder.FORM_DEF_ID.FIELD_ID# #binder.FORM_DEF_ID.FIELD_ID[PRIMARY_KEY]# #binder.options.APP_ID.FORM_DEF_ID.FIELD_ID# #binder.options.APP_ID.FORM_DEF_ID.FIELD_ID[PRIMARY_KEY]# #binder.options.FORM_DEF_ID.FIELD_ID# #binder.options.FORM_DEF_ID.FIELD_ID[PRIMARY_KEY]#
Scope of Use	In a Process Tool part of a Process. In a Form. In a process design.
Sample Attributes	#binder.addCard.title# #binder.cardViewer.addCard.title# #binder.cardViewer.addCard.title[b30bce20-c0a82095-14976e70-fded1735]# #binder.options.addCard.title# #binder.options.cardViewer.addCard.title# #binder.options.cardViewer.addCard.title[b30bce20-c0a82095-14976e70-fded1735]#

App Definition Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	appDef
Description	To retrieve App Definition information
Attributes	#appDef.appId# #appDef.dateCreated# #appDef.dateModified# #appDef.version# #appDef.license# #appDef.name# #appDef.published#
Scope of Use	All components within the App.
Sample Attributes	To display the app definition name: #appDef.name#

App Message Hash Variable (Internationalization)

Name	Description
Prefix	i18n
Description	To support language localization on application level.
Attributes	#i18n. keyName #
Scope of Use	All components within the App.
Sample Attributes	#i18n.logout#
Example	Please see Add Message.

Performer Hash Variable

Name	Description
Prefix	performer
Description	To get user information of the performer of an activity.
Attributes	#performer. activityDefId .id# #performer. activityDefId .username# #performer. activityDefId .firstName# #performer. activityDefId .lastName# #performer. activityDefId .email# #performer. activityDefId .active# #performer. activityDefId .timeZone#
Scope of Use	Elements within and part of a Process. Activity Name. Form mapped as part of process activity mapping. Email Tool configuration as part of process tool mapping. To get activityDefId (activity definition ID), mouseover the activity name in the Activity Mapping tab (Workflow Management Console); there will be an overlay showing the ID. The activity chosen must had already been performed.
Sample Attributes	#performer.runProcess.firstName# #performer.submitLeave.firstName#

Request Parameter Hash Variable

Name	Description
Prefix	requestParam
Description	To access request parameter' values.
Attributes	#requestParam.parameterName[separator]# Separator (, or ;) can be indicated if requestParam is used in datalist filter with multiple values, to define the separator character in data output. Comma "," is used as default if no separator is indicated in cases of multiple values.
Scope of Use	All components within the App.
Sample Attributes	#requestParam.key# can be used specifically to obtain Userview Key value. #requestParam.name[;]# to indicate 'name' variable will store multiple values separated by semicolon. For example, this SQL statement "select * from expenses where title in (#requestParam.title[,]#)" will be translated to "select * from expenses where title in (a,b,c)" to cater for multiple values in "where-in" statement. In a Userview page, one may access the following attributes. #requestParam.key# #requestParam.userviewId# #requestParam.menuId# #requestParam.appId# #requestParam.primaryKey# can be used to retrieve the value passed into Ajax Subforms. For example, when a select box is selected, the id value will be passed into the Ajax Subform and you can use the #requestParam.primaryKey# in JDBC SQL Where clause.

User Hash Variable

Name	Description
Prefix	user
Description	To get user information based on username.
Attributes	#user. username .id# #user. username .username# #user. username .firstName# #user. username .lastName# #user. username .email# #user. username .active# #user. username .timeZone# In Joget Enterprise edition, these additional attributes are available:- User Meta #user. username .meta.KEY# To read additional user meta data stored in dir_user_meta table. Example: #user.cat.meta.duration# will return the value "100". Organization #user. username .organization.id# #user. username .organization.name# #user. username .organization.description# Department #user. username .department.id# #user. username .department.name# #user. username .department.description# #user. username .department.treeStructure# Grade #user. username .grade.id# #user. username .grade.name# #user. username .grade.description# #user. username .grade.organizationId# HOD #user. username .hod.username# #user. username .hod.firstName# #user. username .hod.lastName# #user. username .hod.email# #user. username .hod.active# #user. username .hod.timeZone# Group #user. username .groups.id# #user. username .groups.name# Employment #user. username .employee.code# #user. username .employee.jobTitle# #user. username .employee.isHod# Department HOD #user. username .department.hod.username# #user. username .department.hod.firstName# #user. username .department.hod.lastName# #user. username .department.hod.email# #user. username .department.hod.active# #user. username .department.hod.timeZone#
Scope of Use	All components within the App.
Sample Attributes	#user.admin.email# #user.cat.firstName# #user.{requestParam.username}.email# to retrieve the email address of the user passed via url parameter

Userview Key Hash Variable

Name	Description
Prefix	userviewKey
Description	Userview Key Hash Variable is used solely for the purpose of accessing the current Userview key's value. Typical use case for this hash variable are:- Filtering a Datalist based on Userview Key. Preloading certain form data field (e.g. subform) in a Form or Form part of a process flow based on Userview Key.
Attributes	#userviewKey#
Scope of Use	Datalist Binder SQL Chart Userview Menu

Workflow Variable Hash Variable

Name	Description
Prefix	variable
Description	To get the value of a workflow variable in a Process Flow.
Attributes	#variable. variableName #
Scope of Use	Elements within and part of a Process. Activity Name. Form mapped as part of process activity mapping. Email Tool configuration as part of process tool mapping.
Sample Attributes	#variable.approvalStatus#

Request Hash Variable

Name	Description
Prefix	request
Description	To get the value from the current HttpServletRequest object of the page view.
Attributes	#request.characterEncoding# #request.contextPath# #request.header.NAME# , where NAME is the custom header name. #request.locale# #request.method# #request.pathInfo# #request.protocol# #request.queryString# #request.remoteAddr# #request.requestURI# #request.requestURL# #request.requestedSessionId# #request.scheme# #request.serverName# #request.serverPort# #request.servletPath#
Scope of Use	All components within the App where there is valid HttpServletRequest object. Such object will not be available in background activity such as in Process Tool triggered as a result of Deadlines.
Sample Attributes	To retrieve the "Referer" header attribute value in the screenshot above, one may use the following hash variable. Hash Variable

Platform Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	platform
Description	To retrieve platform specific information.
Attributes	#platform.name# #platform.version# #platform.jdbcDriver# #platform.setting.dataFileBasePath# #platform.setting.deadlineCheckerInterval# #platform.setting.defaultUserview# #platform.setting.fileSizeLimit# #platform.setting.landingPage# #platform.setting.systemDateFormat# #platform.setting.systemLocale# #platform.setting.systemTimeZone# In Joget Enterprise edition, these additional attributes are available:- #platform.license.name# #platform.license.holder# #platform.license.users# #platform.license.appLimit# #platform.license.expiry# #platform.license.activated# #platform.systemKey#
Scope of Use	All components within the App.

Users Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	users
Description	To retrieve information of all the users in the selected group, grade, department and organization. Multiple results will be separated by semicolon.
Attributes	#users.group.GROUP_ID.username# #users.group.GROUP_ID.firstName# #users.group.GROUP_ID.lastName# #users.group.GROUP_ID.fullName# #users.group.GROUP_ID.email# #users.grade.GRADE_ID.username# #users.grade.GRADE_ID.firstName# #users.grade.GRADE_ID.lastName# #users.grade.GRADE_ID.fullName# #users.grade.GRADE_ID.email# #users.department.DEPARTMENT_ID.username# #users.department.DEPARTMENT_ID.firstName# #users.department.DEPARTMENT_ID.lastName# #users.department.DEPARTMENT_ID.fullName# #users.department.DEPARTMENT_ID.email# #users.organization.ORGANIZATION_ID.username# #users.organization.ORGANIZATION_ID.firstName# #users.organization.ORGANIZATION_ID.lastName# #users.organization.ORGANIZATION_ID.fullName# #users.organization.ORGANIZATION_ID.email#
Scope of Use	All components within the App.
Sample Attributes	To return all the users in the current user's groups id: #users.group.{currentUser.groups.id}.fullName# #users.department.D-005.username# #users.group.G-001.email#

Bean Shell Hash Variable

New Feature

This is a new feature in Joget Workflow v6.

Name	Description
Prefix	beanshell
Description	Using environment variable to execute bean shell script. Passing parameter using URL query string syntax.
Attributes	#beanshell.ENVIRONMENT_VARIABLE# #beanshell.ENVIRONMENT_VARIABLE[PARAMETERS_URL_QUERY_STRING]#
Scopeof Use	All components within the App.
Sample Attributes	To execute a script stored in "welcome" environment variable with parameter "username" and "dept": #beanshell.welcome[username={currentUser.username}&dept={currentUser.department.name}]#
Related Tutorials	Add Signature Form Element as Image into Email Content

Space shortcuts

Page tree

What is Hash Variable?

Nested Hash Variable

Escaping the Resultant Hash Variable

List of Hash Variables

Workflow Assignment Hash Variable

Workflow Process Hash Variable

Current User Hash Variable

Date Hash Variable

Environment Variable Hash Variable

Form Data Hash Variable

Form Binder Hash Variable

App Definition Hash Variable

App Message Hash Variable (Internationalization)

Performer Hash Variable

Request Parameter Hash Variable

User Hash Variable

Userview Key Hash Variable

Workflow Variable Hash Variable

Request Hash Variable

Platform Hash Variable

Users Hash Variable

Bean Shell Hash Variable