...
What are Hash Variables?
English |
---|
Hash Variables give users greater flexibility and freedom in accessing useful information or relevant run-time values from the system.Hash variable is a placeholder variables in Joget are placeholders used to dynamically display data from various sourceswithin your application. It allows youapplications. They allow users to insert dynamic content without hardcoding values, making your applications more flexible and customizable.Key Uses of Hash Variables in Joget:Fetching Form Data: Retrieve and display data from form fields.plaintext#form.formId.fieldId#
Example: #form.myForm.name# gets the value from the "name" field in the form "myForm".Accessing Workflow Variables: Display values from workflow variables.plaintext#variable.variableId#
Example: #variable.requesterName# gets the value of the "requesterName" variable.System Information: Get details like the current date or logged-in user info.plaintext#currentUser.username#
#date.today#
Example Uses:Personalized Email Content: Use hash variables to customize automated emails. plaintextHello #form.requestForm.name#,
Your request submitted on #date.today# has been approved.
Dynamic User Interface: Show different content based on user input or workflow state. plaintext{% if #form.feedback.rating# >= 4 %}
Thank you for your positive feedback!
{% else %}
We're sorry to hear that. Please tell us how we can improve.
{% endif %}
SummaryHash variables in Joget make your applications dynamic by allowing you to fetch and display data from forms, workflows, and the system, without hardcoding values. They help create flexible and user-friendly applications. |
A hash variable is a special hash-escaped keyword that can be used in :
- Form Builder
- List Builder
- UI Builder
- BeanShell code
- 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. Download the hash variable demonstration app for a quick look.
...
which enhances flexibility and customization. Hash variables can fetch and display data from various sources such as forms, workflows, and the system itself. They promote customization and flexibility by avoiding hardcoded values, ultimately improving the user-friendliness of Joget applications. |
A hash variable is a special hash-escaped keyword that can be used in :
- Form Builder
- List Builder
- UI Builder
- BeanShell code
- 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. Download the hash variable demonstration app for a quick look.
Tip |
---|
To conveniently access the list of all hash variables available, use the shortcut combination Ctrl + Shift + 3 in any of the components above to bring up the Property Assistant. |
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}.
Code Block | ||||
---|---|---|---|---|
| ||||
#prefix.{prefix.variableKey}# |
Code Block | ||
---|---|---|
| ||
#date.{envVariable.dateFormat}#
#user.{variable.username}.firstName#
#form.tableChild.field1[{form.tableParent.childId}]# |
Form Hash Variable by Index
You can pass an index or primary key value to a Hash Variable for retrieval.
The syntax for the inner Hash Variable is wrapped by a pair of [square brackets] .
Code Block | ||||
---|---|---|---|---|
| ||||
#form.myTable.fieldId.[primaryKeyValue]# |
Here are some examples:
Code Block | ||
---|---|---|
| ||
#form.contact.name[007]# where "007" is the primary key or "id" value of database table "app_fd_contact". |
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
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}.
Code Block | ||||
---|---|---|---|---|
| ||||
#prefix.{prefix.variableKey}# |
Code Block | ||
---|---|---|
| ||
#date.{envVariable.dateFormat}#
#user.{variable.username}.firstName#
#form.tableChild.field1[{form.tableParent.childId}]# |
Form Hash Variable by Index
You can pass an index or primary key value to a Hash Variable for retrieval.
The syntax for the inner Hash Variable is wrapped by a pair of [square brackets] .
Code Block | ||||
---|---|---|---|---|
| ||||
#form.myTable.fieldId.[primaryKeyValue]# |
Here are some examples:
Code Block | ||
---|---|---|
| ||
#form.contact.name[007]# where "007" is the primary key or "id" value of database table "app_fd_contact". |
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, for example "#form.table.photo?img2base64#". You may include multiple by defining semicolon ";" separated values.
...
Code Block | ||
---|---|---|
| ||
#envVariable.script?java# #envVariable.script?nl2br;json# #form.table.users?separator(, )# |
Hash Variable Return ValuesVariable Return Values
- If the record does not exist, "#form.table.field#" returns the same = "#form.table.field#". Use the ternary operator ( condition ? exprIfTrue : exprIfFalse ) to check and set to NULL if the return value matches the origin hash variable (if used in BeanShell or Javascript).
- If record exist but field is empty, "#form.table.field#" returns empty = "".
- If record exist and field has value "abc"If the record does not exist, "#form.table.field#" returns the same value = "abc"#form.table.field#". Use the ternary operator ( condition ? exprIfTrue : exprIfFalse ) to check and set to NULL if the return value matches the origin hash variable (if used in BeanShell or Javascript).
- If record exist but field is empty, "#form.table.field#" returns empty = "".
- If record exist and field has value "abc", "#form.table.field#" returns the value = "abc".
Hash Variable Features In Joget DX Community Edition
Some hash variables listed below are not available in the Joget Community Edition, read the Detailed Plugin Comparison Between Editions for more information.
...
- .
Hash Variable Features In Joget DX Community Edition
Some hash variables listed below are not available in the Joget Community Edition, read the Detailed Plugin Comparison Between Editions for more information.
Hash Variable - Property Assistant
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This is a new feature in Joget DX 8. |
Property Assistant is a new feature in Joget DX 8, that allows you to quickly access and insert Hash Variables (and others)in any form element, UI element or list.
The Property Assistant allows you to choose a hash variable's attributes from a select box (Figure 1).
Figure 1: Property Assistant - Hash Variable Attributes Selection
You can also insert Nested Hash Variables easily using the Property Assistant by clicking on the desired attribute that will include the nested variable and then clicking back on the variable list to choose a variable to insert. (See Figure 2)
Figure 2: Property Assistant - Nested Hash Variable
System-wide Hash Variable
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This is a new feature in Joget DX 8.2. |
...
The System Variables menu introduces system-wide Hash Variables, which allows users to create and define custom hash variables that can be used in Property Assistant. This means that system-wide hash variables can be used in any app as it is not tied to any specific app.
System-wide Hash Variables can be accessed in Property Assistant using the #sysVariable.KEY# hash variable, where KEY is defined in the System Variables settings page.
The Property Assistant allows you to choose a hash variable's attributes from a select box (Figure 1).
Figure 1: Property Assistant - Hash Variable Attributes Selection
You can also insert Nested Hash Variables easily using the Property Assistant by clicking on the desired attribute that will include the nested variable and then clicking back on the variable list to choose a variable to insert. (See Figure 2)
Figure 2: Property Assistant - Nested Hash Variable
List Of Joget DX Hash Variables
...
Name | Description |
---|---|
Prefix | userviewKey |
Description | Userview Key Hash Variable is used solely for the purpose of accessing the current UI key's value. Typical use case for this hash variable are:-
|
Attributes |
|
Scope of Use |
Workflow Variable Hash Variable
...
Name | Description | |||||
---|---|---|---|---|---|---|
Prefix | beanshell | |||||
Description | Using App Variable to execute bean shell script. Passing parameter using URL query string syntax. | |||||
Attributes |
| |||||
Scope of Use |
| |||||
Sample Attributes | To execute a script stored in the "welcome" app variable with parameter "username" and "dept":
| |||||
Related Tutorials |
...
** for "datalist.col.xx.ID.column" variables, the "column" parameter refers to the order of the column in the list starting from 0. hence, to refer to the first column in a list called list_f1, your hash variable would look like this : #datalist.col.sum.list_f1.column_0
** the column are counted from 0, and does not include the default checkbox included in list tables
Expression Hash Variable
this : #datalist.col.sum.list_f1.column_0
** the column are counted from 0, and does not include the default checkbox included in list tables
Expression Hash Variable
Name | Description |
---|---|
Prefix | exp |
Description | Mathematical and string operations on hash variables |
Attributes | #exp.variable# |
Scope of Use |
|
Sample Attributes | Testing Values
Mathematical operators
Logical operators
Relational operators
Ternary Operator (If Else)
String methods Note: Basically most of the String methods can be used, using `?expression` to escape single quote in value.
|
Name | Description |
Prefix | exp |
Description | Mathematical and string operations on hash variables |
Attributes | #exp.variable# |
Scope of Use |
|
Sample Attributes | Testing Values
Mathematical operators
Logical operators
Relational operators
Ternary Operator (If Else)
String methods Note: Basically most of the String methods can be used, using `?expression` to escape single quote in value.
Custom Methods
Custom Methods
Math methods Note: All java.lang.Math methods can be used.
|
Report Builder Hash Variable
Warning |
---|
The API IP/Domain Whitelist setting in General Settings needs to be configured in order for reportLink hash variable to work. If a request is from a non-whitelisted IP/domain, the response will be a HTTP 400 Bad Request. |
...
To retrieve the particular report based on the reportId.
To know more about Report Builder, see here.
...
- #reportLink.rp_report01#
...
- All components within the App.
...
- #reportLink.financialReport#
Math methods Note: All java.lang.Math methods can be used.
|
Report Builder Hash Variable
Warning |
---|
The API IP/Domain Whitelist setting in General Settings needs to be configured in order for reportLink hash variable to work. If a request is from a non-whitelisted IP/domain, the response will be a HTTP 400 Bad Request. |
Name | Description |
---|---|
Prefix | reportLink |
Description | To retrieve the particular report based on the reportId. To know more about Report Builder, see here. |
Attributes |
|
Scope of Use |
|
Sample Attributes |
|
Code Builder Hash Variable
Name | Description |
---|---|
Prefix | code |
Description | To retrieve the template based on the code snippet ID. |
Attributes |
|
Scope of Use |
|
Sample Attributes |
|
uiListCount Hash Variable
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This is a new feature in Joget DX 8. |
Name | Description | ||
---|---|---|---|
Prefix | uiListCount | ||
Description | The uiListCount hash variable is primarily utilized to retrieve the Datalist or Inbox menu count value. | ||
Attributes |
| ||
Scope of Use |
| ||
Sample Attributes | See examples below, based on the usage within the default CRM application:
|
Escape Format
Code Builder Hash Variable
...
To retrieve the template based on the code snippet ID.
...
- #code.cs-templateId#
...
- All components within the App.
...
- #code.cs-calculationScript#
...
Hash Variable
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This is a new feature in Joget DX 8. |
Name | Description |
---|---|
Prefix | uiListCount |
Description | The uiListCount hash variable is primarily utilized to retrieve the Datalist or Inbox menu count value. |
Attributes |
| Scope of Use |
Warning |
---|
uiListCount cannot be used inside UI permission. This is due to: ERROR 15 May 2024 09:27:20 org.apache.jsp.WEB_002dINF.jsp.error500_jsp - Handler dispatch failed; nested exception is java.lang.StackOverflowError2org.springframework.web.util.NestedServletException: Handler dispatch failed; nested exception is java.lang.StackOverflowError |
See examples below, based on the usage within the default CRM application:
- #uiListCount.MENU_ID# where MENU_ID is the id of the menu in your Userview for Datalist or Inbox (Example usage: "#uiListCount.proposal_inbox_list#")
- #uiListCount.UI_ID.MENU_ID# where UI_ID is the id of the Userview (Example usage: "#uiListCount.crm_userview_sales.proposal_inbox_list#")
Escape Format Hash Variable
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This is a new feature in Joget DX 8. |
?decimal(decimal_number) | |||
Description | The escape format hash variable used to allow the formatting of decimal places.
| ||
Attributes |
| ||
Scope of Use |
| ||
Sample Attributes |
|
Stats Hash Variable
Name | Description | ||
---|---|---|---|
Prefix | stats | ||
Description | Display various Joget system and app statistics. | ||
Attributes |
| ||
Scope of Use |
| ||
Sample Attributes |
| ||
Name | Description | ||
Prefix | ?decimal(decimal_number) | ||
Description | The escape format hash variable used to allow the formatting of decimal places.
| ||
Attributes |
| ||
Scope of Use |
| ||
Sample Attributes |
|
Hash Variables In Joget Marketplace
...
Download Demo App
View file | ||||
---|---|---|---|---|
|