What is Hash Variable?
Hash Variables gives users greater flexibility and freedom in accessing useful information or relevant runtime 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.
Nested Hash Variable
Since version 3.0.3, 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 '{' and '}'.
Syntax:
#prefix.{prefix.variableKey}#
|
Example:
#date.{envVariable.dateFormat}#
#user.{variable.username}.firstName#
#form.tableChild.field1[{form.tableParent.childId}]#
|
List of Hash Variables
Workflow Assignment Hash Variable
| Name | Description |
|---|
| Prefix | assignment |
| Description | To get workflow activity information of the current assignment. |
| Attributes | - #assignment.processId#
- #assignment.processDefId#
- #assignment.processName#
- #assignment.processVersion#
- #assignment.processRequesterId#
- #assignment.description#
- #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.
|
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:- 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. |
| Attributes | |
| Scope of Use | - All components within the App.
|
| Sample Attributes | #date.h:mm a# #date.EEE, d MMM yyyy h:mm:ss a#
#date.DAY+7.EEE, d MMM yyyy h:mm:ss a#
|
Environment Variable Hash Variable
| Name | Description |
|---|
| Prefix | envVariable |
| Description | To retrieve Environment Variable value. Learn more about Environment Variables. |
| Attributes | |
| 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##form.registration.registeredDate[0001]#
#form.registration.registeredDate[{variable.recordId}]#
|
App Message Hash Variable (Internationalization)
| Name | Description |
|---|
| Prefix | i18n |
| Description | To support language localization on application level. |
| Attributes | |
| Scope of Use | - All components within the App.
|
| Sample Attributes | #i18n.app.hello# |
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 | |
| Description | |
| Attributes | |
| Scope of Use | |
| Sample Attributes | |
User Hash Variable
| Name | Description |
|---|
| Prefix | |
| Description | |
| Attributes | |
| Scope of Use | |
| Sample Attributes | |
User Variable Hash Variable
| Name | Description |
|---|
| Prefix | |
| Description | |
| Attributes | |
| Scope of Use | |
| Sample Attributes | |
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 | |
| Scope of Use | |
Workflow Variable Hash Variable
| Name | Description |
|---|
| Prefix | variable |
| Description | To get the value of a workflow variable in a Process Flow. |
| Attributes | |
| 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# |