Writing Assistant Plugin

Introduction

The Marketplace is a space for listing all of the plugins created by the Joget team and official documentation on how to use and implement each of the plugins. The following steps can help knowledge workers write marketplace articles.

Plugin Information

Plugins Available in the Bundle:

• Writing Assistant Plugin (Form Element)

This plugin bundle is compatible with DX 7 onwards.

Get Started

Prerequisites

• Joget Version: DX 7, DX 8, DX 9
• OpenAI Account: Required to obtain a valid ChatGPT API Key
• Internet Access: Required for API calls to OpenAI

Where to Get the Plugin

You can download this plugin/app from the Joget Marketplace or the JogetOSS GitHub Repository.

How to Install

1. Navigate to the Joget Marketplace. Click Download on this plugin screen (It will be a .jar file).
2. In the Joget Console, navigate to Admin Bar > System Settings > Manage Plugins.
3. Click the Upload Plugins button.
4. Under Upload Plugin, select the .jar file you downloaded and click Upload.

How to Use It

1. In Form Builder, drag and drop a Text Area element and the Writing Assistant Plugin to your form.
2. Click the Text Area element to configure it. Take note of its field ID.
3. Click the AI Writing Assistant element.
4. Enter your OpenAI ChatGPT API Key and the text area field ID in the plugin configuration. Save the form.
5. Add the form in UI Builder using the Form Menu element.
6. The AI will rephrase your message based on the prompt.

Configure Writing Assistant Plugin Properties

Fields to Configure:

• Model: Select the OpenAI Model used.
• API Key: Your OpenAI ChatGPT API Key.
• Field Id for AI Assistant: The field used to obtain the input.
• Debug Mode: Show relevant debug in the server log for debugging purposes.
• Proxy Domain: The ID of the form field where the rephrased message will be displayed.

Expected Outcome

You can now paste text into the Text Area field and configure the tone, format or instructions in the AI Writing Assistant field. After clicking Send, the text in the Text Area field will be rephrased.

Related Documentation

• Joget AI Bundle
• AI Agent Builder

Video Tutorial

Download Plugin

Download the plugin from the Joget Marketplace.

Download Sample App