Font Size:
Ask Joget AI

UUID Generator

Introduction

The UUID Generator plugin adds unique ID generation to Joget, available in two forms:

  • UUID Generator Field: a form element that auto-generates a UUID when a form is submitted with that field empty.
  • UUID Generator Tool: a process/workflow tool that generates a UUID and stores it into a form field and/or a workflow variable.

Both support configurable length, optional dashes, uppercase output, and automatic retry-on-collision to guarantee uniqueness against the target form's data table.

Plugin Information

Plugins Available in the Bundle:

  • UUID Generator (Form Element + Process Tool)

This plugin is compatible with Joget DX 9.

Where to Get the Plugin

You can download the plugin JAR file from the official JogetOSS GitHub Repository.

How to Install

  1. Download the latest release .jar file from the repository page.
  2. In the Joget Console, navigate to the Admin Bar > System Settings > Manage Plugins.
  3. Click the Upload Plugins button.
  4. Under the Upload Plugin screen, select your downloaded JAR file and click Upload.

How To Use It

Form Element: UUID Generator Field

  1. Open your app in App Composer and go to Form Builder. You can either edit an existing form or create a new one, for example, a form named 'test'.
  2. Click the UUID Generator element to open its properties panel and configure it.

Configure UUID Generator Field Properties

Fields to configure:

  • Label: Display label for the field.
  • Field ID: The form field's unique ID.
  • UUID Length: Length of the generated value. Max 36 if dashes are included; unlimited if dashes are disabled (hex characters are concatenated to reach the requested length).
  • Include Dashes: When enabled, generates a standard UUID format (e.g. 550e8400-e29b-41d4-a716-446655440000). When disabled, only hex characters are used.
  • Uppercase: Converts the generated value to uppercase.
  • Validator: Optional validator to run against the generated value; the field retries generation (up to 20 attempts) until validation passes.

How to Run the Plugin

When the form is submitted and the field is empty (and not read-only), the plugin generates a value automatically; the user never types it in. The unfilled field shows (auto-generated) as a placeholder before submission.

Before submitting the Form:

After submitting the Form, it goes to the same Record:

Process Tool: UUID Generator Tool

  1. Open your app in App Composer and go to Process Builder. You can either edit an existing Process or create a new one, for example, a Process named 'Test'.
  2. Drag a Tool element onto the Canvas, then select UUID Generator Tool from the dropdown list of available tools, and configure it.

Configure UUID Generator Tool Properties

Fields to configure:

  • Form: Target form to store the generated UUID into.
  • Field ID: Target field on that form to store the value in. Leave empty to skip storing to the form.
  • Record ID: Record to update. Leave empty to use the current process record ID.
  • UUID Length: Same as the field element length of the generated value.
  • Include Dashes: Same as the field element standard UUID format vs. hex-only.
  • Uppercase: Converts output to uppercase.

How to Run the Tool

When the process activity executes, the tool generates a UUID, checks it against the target form's table for uniqueness (retrying up to 20 times on collision), then writes it to the configured form field and/or workflow variable.

Run the process:


Note
If Field ID is left empty, the tool will skip writing to the form entirely. Use this configuration when you only need the generated value stored as a Workflow Variable, not on a form field.

Uniqueness Guarantee:

Both the field and the tool retry generation (up to 20 attempts) whenever:

  • A configured Validator rejects the value (Field), or
  • The generated value already exists in the target form's table (Tool, and Field when combined with a uniqueness validator).

This makes the plugin safe to use as a primary key or reference number generator without manual duplicate checks.

Common Use Cases: Generating a unique reference number/transaction ID on form submission. Populating a hidden primary-key-style field automatically. Generating a correlation ID during a workflow process and storing it as a workflow variable for use in later activities or notifications.

Created by Nabila Jahan Last modified by Debanraj Ravindran on Sep 25, 2026