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.
Available Hash Variables:-
| Children Display |
|---|
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:
| Code Block |
|---|
#prefix.{prefix.variableKey}# |
Example:
| Code Block |
|---|
#date.{envVariable.dateFormat}#
#user.{variable.username}.firstName#
#form.tableChild.field1[{form.tableParent.childId}]#
|
Assignment
To get workflow activity information of the current assignment:
- #assignment.processId#
- #assignment.processDefId#
- #assignment.processName#
- #assignment.processName#
- #assignment.processVersion#
- #assignment.processRequesterId#
- #assignment.description#
- #assignment.activityId#
- #assignment.activityName#
- #assignment.activityDefId#
- #assignment.assigneeId#
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#
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.
Form
To get data from form table:
- #form.formDataTableName.fieldName#
Wiki Markup \#form._formDataTableName_._fieldName\[record id\]_\# (Only available in 3.1)- #form.fieldName# (used in Form Builder or plugin configuration when the form data table name is already specified)
For example:
| Code Block |
|---|
#form.registration.registeredDate#
#form.registration.registeredDate[0001]#
#form.registration.registeredDate[{variable.recordId}]# //using nested Hash Variable with curly bracket.
#form.issuedDate#
|
Workflow Variable
To get the value of a workflow variable:
- #variable.variableName#
For example:
| Code Block |
|---|
#variable.approvalStatus#
|
Date
To get date time according to a specified format:
- #date.javaSimpleDateFormat# (refer to http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html for more formatting patterns)
For example:
| Code Block |
|---|
#date.h:mm a# // 12:08 PM
#date.EEE, d MMM yyyy h:mm:ss a# // Wed, 4 Jul 2009 12:08:56 PM
|
User (v2.0.0 and above)
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#
For example:
| Code Block |
|---|
#user.admin.email# |
Apart from all of the existing Hash Variables supported in Joget version 2 as described above, these are the new hash variables supported in v3.
...