HTML Decode Hash Variable

Introduction

HTML Decode Hash Variable decodes one layer of HTML5 entities using the same Jsoup entity support used by Joget's Custom HTML element.

Plugin Information

Plugins Available in the Bundle:

• HTML Decode Hash Variable

This plugin bundle is compatible with Joget DX 8 and DX 9.

Get started

Where to get the plugin

You can download this plugin from the Joget Marketplace.

How to install

1. Click Download on this plugin screen (It will be a .jar file).
2. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > System Settings > Manage Plugins and click the Upload Plugins button.
3. Under Upload Plugin, select the plugin .jar file you downloaded and click Upload.
4. Depending on the plugin type, you can now view your new plugin in your form, List, or UI Builder.
5. Remember to uninstall the old plugin before uploading a new version.
6. The Joget Knowledge Base has more information on managing and developing plugins.

How to use it

Apply the Hash Variable by using the hash variable #htmlDecode.form.TABLE.COLUMN?noescape# in any part of your app that supports hash variables (example: form fields, email tool, UI components, or process tools).

Syntax & Usage

For a text field, email subject, or other plain-text destination: 
#htmlDecode.form.TABLE.COLUMN?noescape#

For example:
#htmlDecode.form.first.name?noescape# 

To specify a primary key explicitly: 
#htmlDecode.form.TABLE.COLUMN[PRIMARY_KEY]?noescape#

Notes

• Do not wrap the form hash variable in {...}. The plugin resolves the form hash internally with ?noescape, preventing Joget from sanitizing an intermediate nested-hash value before it reaches the entity decoder.
• The ?noescape suffix is required. Without it, Joget applies its default stripHtmlRelaxed post-processing after this plugin and may turn decoded characters such as &, <, and > back into HTML entities. The ?htmlsuffix explicitly HTML-encodes the result and therefore must not be used for plain-text output.
• Only use ?noescape at a destination that performs its own context-specific escaping, such as Joget's Text Field template, or at a plain-text destination such as an email subject. Do not insert the result raw into an HTML body.
• The decoder operates exactly once and replaces line breaks with spaces while removing unsafe control characters.

Expected Outcome

The plugin will be able to decode HTML special characters (like & for & or < for <).