Hash Variable Plugin

Introduction

The Hash Variable Plugin is used to extend the support for processing Hash Variables in Joget. A usable Hash Variable plugin must extend the org.joget.apps.app.model.DefaultHashVariablePlugin abstract class.

Abstract Class

org.joget.apps.app.model.DefaultHashVariablePlugin

• Under wflow-core module.
• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
• Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
• A base abstract class to develop a Hash Variable plugin. 

Method Detail

Abstract Methods

getPrefix

public abstract java.lang.String getPrefix()
Prefix of a Hash Variable use as identifier.

processHashVariable

public abstract java.lang.String processHashVariable(java.lang.String variableKey)
Processing the Hash Variable and return a value to replace the Hash Variable.

Return Null to skip the replacement of Hash Variable.

Overridable Methods

escapeHashVariable

public java.lang.String escapeHashVariable(java.lang.String variable)
Escape special character in the value. Default to escape Regex in the value. 

availableSyntax

public java.util.Collection<java.lang.String> availableSyntax()
List the possible syntax combination to populate in Hash Variable Assistants in Property Editor. Default to "prefix.KEY".  

Plugin Properties Options

• Does not support. 

Related Tutorials

• Guideline for Developing a Plugin
• How to develop a Bean Shell Hash Variable 

Related Community Plugins

• App Message Hash Variable
  org.joget.apps.app.lib.AppMessageHashVariable (wflow-core) 
• Current User Hash Variable
  org.joget.apps.app.lib.CurrentUserHashVariable (wflow-core) 
• Date Hash Variable
  org.joget.apps.app.lib.DateHashVariable (wflow-core) 
• Environment Variable Hash Variable
  org.joget.apps.app.lib.EnvironmentVariableHashVariable (wflow-core) 
• Form Data Hash Variable
  org.joget.apps.app.lib.FormHashVariable (wflow-core) 
• Performer Hash Variable
  org.joget.apps.app.lib.PerformerHashVariable (wflow-core) 
• Request Hash Variable
  org.joget.apps.app.lib.RequestHashVariable (wflow-core) 
• Request Parameter Hash Variable
  org.joget.apps.app.lib.RequestParameterHashVariable (wflow-core) 
• User Hash Variable
  org.joget.apps.app.lib.UserHashVariable (wflow-core) 
• User Variable Hash Variable
  org.joget.apps.app.lib.UserVariableHashVariable (wflow-core) 
• Workflow Assignment Hash Variable
  org.joget.apps.app.lib.WorkflowAssignmentHashVariable (wflow-core) 
• Workflow Variable Hash Variable
  org.joget.apps.app.lib.WorkflowVariableHashVariable (wflow-core)