AI Designer

Introduction

This plugin adds a new option under the Design New App page to assist with app creation using a Generative AI language model. It builds a foundational app skeleton based on user instructions or prompts. You can further enhance the app’s functionality after generation. This article demonstrates how to create a Purchase Requisition App using the plugin.

Plugin information

• Plugin Name: Generative AI (Beta)
• Compatible with: Joget Enterprise version 8.1.0 onward
• Other Requirements:
  • OpenAI API Key
  • LLM Key
  • A backend Python container (optional if you are using a Joget-hosted container)

Get started

Prerequisites

To use this plugin, ensure you have:

• Joget Enterprise version 8.1.0 or later.
• The Generative AI Plugin was downloaded and installed.
• The Process Enhancement Plugin DX was downloaded and installed.
• An LLM Key. For example, you can obtain one from OpenAI.
• A backend Python container (optional if you are using a Joget-hosted container)

Where to get the plugin

You can get the plugin from the Joget Marketplace.

How to install

1. Download the plugin JAR file from the releases page.
2. Go to Settings > Manage Plugins > Upload Plugin.
3. Once uploaded, the plugin will be available in your Joget environment.

How to use it?

Configuring a new AI Service

Before using the Joget AI Designer, an AI Service is required to be configured. After obtaining an API Key from your desired AI Service. This tutorial uses OpenAI as the AI Service. Follow these steps:

1. Navigate to Design App > Create New App from the left sidebar in the App Center.

2. Select the Generative AI option.
   

3. Click Launch Joget AI Designer.
   

4. Under the Link your API Server icon, paste an API Server URL and API Server Key into the provided fields.

5. Click Save.
   

6. Click the Setup AI Services icon. 

7. Click Configure.
   

8. For AI Service Name, provide a display name for the AI model.

9. For Model Class, select an AI model from the drop-down list.

10. For Model Name, select the model version from the drop-down list.

11. Optionally, re-enter the API Key for API Key (Optional).
    

12. Click Create and click Save.

13. Click the PII Masking tab to configure PII Masking.

Creating an app with AI Designer

1. After setup, click Design your app on the top right.

2. Select either of the following options:

• • Text: Creates an app design based on text.

  • Image: Creates an app design based on an image.

This tutorial uses the Text option.

3. Input your prompt text.
   As an example:
   "Design an expenses claim application. The process begins with the employee submitting an expense claim form detailing the expenses incurred. The claim is then reviewed by the immediate supervisor for initial approval. Once approved, it is forwarded to the finance department for verification of receipts and compliance with company policy. If the claim exceeds $500, it requires additional approval from the department head. After all approvals, the finance department processes the reimbursement and notifies the employee of the payment status."

4. An Any further adjustments to your query? reply message is displayed in the chatbox with the following options available:
   

• • Enhance Query: Uses AI to improve the query presented by adding additional details to yield improved results.

    • Revert: Reverts the Enhanced Query response back to the original query.

    • Regenerate: Regenerate a new Enhanced Query response.

    • Continue: Proceed to the Process Proposal stage.

  • PII Masking: Redacts sensitive information presented in the query to improve security and anonymity.

    • Revert: Reverts the PII Masking response back to the original query.

    • Regenerate: Regenerate a new PII Masking response.

    • Continue: Proceed to the Process Proposal stage.

  • Skip: Skips any adjustments and proceeds to the Process Proposal stage.

Core App Design Stages

The process of designing an app using Joget AI Designer consists of four main stages which include Process Proposal, Forms and Participants, Process Design, and Form Design. Complete all of these steps to generate a functional app.

1. In the Shall we proceed to the Process Proposal stage? page, click Process Proposal.

2. A summary of the app design is displayed. The following options are available:
   

• Refine: Allows users to refine the project proposal by adding additional prompts.

• Regenerate: Regenerate a new project proposal.

• Form Design: Proceed to the Forms and Participants stage.

3. Once the process proposal is confirmed, click Form and Participants. A list of forms and participants will then be displayed.

4. Click Process Design. A preview of the process, including all forms and processes, is displayed. The process can be displayed either in Visual view or Code view by clicking on the toggle.

5. Click Form Design. Click the ellipses beside the form to display two optional options:
   

• Replace: Replace the form by providing an option to design a new form with a prompt using AI.

• Remove: Deletes the form.

6. Add a new form or additional form by clicking Add Form to input a prompt for a new form. The AI will generate a new form.
   

7. If no further changes are necessary, click Create App.

8. Provide an App ID and App Name, and click Save to create the app.

Expected outcome

After completing the steps, you will be prompted to Launch App Composer and have created an Expense Claims App. It can handle approvals based on the total claim amount criteria. The app can be configured further, just like any other Joget app.

Download plugin

•  Generative AI Plugin
• Process Enhancement Plugin DX

Download sample app