QR Code Generator Tool

Introduction

The QR Code Generator Tool allows you to generates a QR code to be attached to an email through process or post-form processing.

Plugin information

  • Plugin Name: QR Code Generator Tool
  • Joget DX Compatibility: Joget DX 8

Get started

Prerequisites

  1. Set up SMTP values in the Joget App so the email tool works properly.
    For more information, see General Settings > SMTP Settings and Sign in with app passwords to generate the password for SMTP Gmail.

Where to get the plugin

How to install the plugin

  1. Download the plugin JAR file from the releases page.
  2. Go to Settings > Manage Plugins > Upload Plugin.
  3.  You can import the demo app or create the app from scratch.

How to use it

Importing the demo app

For the demo app, go to Joget Home or All Apps and click on Import App to import the downloaded demo app (see another KB - Import a Joget App for more details).

Creating the app from scratch
  1. Create a new form.
  2. Drag and drop the File Upload element in the canvas.
  3. Set the field to be Readonly.
  4. Drag a text field, which will be the value for the generated QR code.

Configure post form submission processing

  1. Go to Form Builder > Settings > Advanced > Post Form Submission Processing and choose Multi Tools.
  2. In the Run Tool field, choose Both data creation and update.
  3. Set the tools the QR Code Generator Tool and Email Tool for post-processing.
  4. Fill in the plugin configurations based on QR Code Generator Tool Properties. The value of the generated QR code will be the text field created earlier.
  5. Complete the plugin configurations using the Email Tool. In the message for the Email Tool, input the image source as the field for the generated QR Code.


    Tool Message Value
    Email Tool <img src="cid:#form.qcgda_qrcode.qr_field_to_be_uploaded?url#" />
  6. Remember to complete the attachment section in the Email Tool to embed the picture into the email.
  7. Complete the form. The process tool will automatically generate the QR Code to be stored in the File Upload field.

  8. An email with the QR code will be sent.
  9. Then, click Edit.
  10. The generated QR Code is displayed in this field. You can also manually download the QR Code for verification.

Configure QR code generator tool properties

In the previous form, configure the QR Code Generator Tool and specify the Field ID for the file upload element where the QR code will be saved.

Fields to configure:

  • Form: Form for the QR Code Generator Tool.
  • Field: Field ID for uploading the QR Code.

In the QR Code Properties, select the Format and fill in the value.

Fields to configure:

  • Format: Options for Format.
    • URL
    • Text
  • URL: 
    Only shown when URL is selected for Format.
  • Value
    Only shown when Text is selected for Format.
  • Height: Height of QR code.
  • Width: Width of QR code.

Expected outcome

After implementing the QR Code Generator Tool, QR codes will be generated and sent via email, as seen in the example below.

Download plugin

Download demo app

Download the demo app for the QR Code Generator Tool:
Created by Julieth Last modified by Aadrian on Nov 19, 2024