...

Introduction

...

The easiest way to see how the Plugin Template Pack function  is to create a simple Application. Here are the steps:

Steps To Import This Plugin

1. Go to the website https://github.com/jogetoss/plugin-template-pack.

2. Go to the "Releases" page (See Figure 1).

Figure 1: Release page link

3. Click on the .jar file to initiate the download (See Figure 2).

Image Modified

Figure 2: Plugin-template-pack .jar file

4. Go to your Joget Workflow localhost or server and log in as admin.

...

9. The Joget Workflow Knowledge Base has more information on managing and developing plugins.

...

Steps

...

To Use This Plugin

1. Start the Joget server and open the   App Center .

2. Log in as in as admin and click on   Design New App  (See Figure 3) or click on existing application.

Figure 3: Design New App

3. For new applications, fill  up up the App ID with camel case, and App Name, and click on the "Save" button. (See Figure 4)

Figure 4: Fill up App Details

4.  Create a New Form, fill up Form ID in camel case, Form Name, and Table Name then click on the Save button (See Figure 5).

Figure 5: Fill up Form Details

5. Fill up the form with several fields, save it and then click the "Generate App" button (See Figure 6).

Figure 6: Save Form and Generate App

6. After Clicking the "Generate App" button, generate the app with CRUD and Datalist included (See Figure 7).

Image Modified

Figure 7: Generate CRUD and Datalist

8.  After generating the app, Launch the UI Builder  by clicking on the newly created CRUD. (See Figure 8).

Image Modified

Figure 8: Enter UI builder

9. Navigate the user view menu elements and add the "Plugin Template Management" to the User view Menu. (See Figure 9).

Figure 9: Plugin Template Management

10. Leave the configuration of Plugin Template Management properties as default and save the User view Builder.11. Launch the app and navigate to the

Plugin Template Management

...

Image Removed

Figure 10

12. Fill up the Plugin Template Management Page accordingly and for the plugin choose any one of the formatter under Datalist Column Formatter. (See Figure 11)

Image Removed

Figure 11

13.  Configure the plugin by clicking the "Configure Plugin" button according to Figure 12 and then submit it.

Image Removed

Figure 12

14. Click the "Save" button to create a Plugin Template for formatting Datalists. (See Figure 13)

Image Removed

Figure 13

15. Click the List - Plugin Template to open the design view of the Datalist builder. (See Figure 14)

Image Removed

Figure 14

16.  Preview the Datalist before applying the "Plugin Template - Datalist Column Formatter" for comparing the effect of the Formatter. (See Figure 15)

Image Removed

Figure 15

17. In the Datalist builder go to properties of a column and navigate to General > Action Mapping > Formatter  select "Plugin Template - Datalist Formatter" in the Formatter drop-down list. (See Figure 16)

Image Removed

Figure 16

18. Navigate to General > Action Mapping > Formatter > Plugin Template - Datalist Formatter  and choose the template that has been created and press OK to apply it. (See Figure 17)

Image Removed

Figure 17

19. Repeat steps 17 and 18 for as many columns as you want in the Datalist and then save it.

20. Preview the Datalist to view the intended effect of the template of Plugin Template - Datalist Formatter. (See Figure 18)

Image Removed

Figure 18

21. Using one Plugin Template created, we can now apply the effect and format of the template to as many columns as we want in the Datalist builder increasing efficiency and reducing the chance of human error. (See Figure 19)

Image Removed

Figure 19

Userview/ Form Permission

Steps to use the Plugin Template - Userview / Form permission:

1. Launch the app "Plugin Template Demo" and create a new template again on the Plugin Template Management Page by clicking the "New" button.

2. Fill up the Plugin Template Management Page accordingly and for the "Plugin" field choose any one of the formatter under Userview Permission or Form Permission. The is Admin is chosen for the Plugin field. (See Figure)

Image Removed

Figure

3. Click the "Configure Plugin" button and as there are no properties to configure for this plugin, hence submit the plugin and save the template by clicking the "Save" button.

4. The Permission Plugin Template created can be applied to enforce Permission rules to both Form and Userview.

For Userview

1. The Permission plugin template created can be applied at the Userview itself or at the Userview Category level in the Userview using the Permission Control feature.

2. For applying the Permission plugin template at the Userview  itself, go to the Userview Builder, select Settings, navigate to Configure Layout > Theme (DX Progressive Theme) > Configure Permission and choose Plugin Template - Permission for the Permission Type field. (See Figure)

Image Removed

Figure

3. Navigate to Permission Type (Plugin Template - Permission) and select the template you have created and save the Userview by clicking the "Save" button. (See Figure)

Image Removed

Figure

4.  For applying the Permission plugin template at the Userview Category level, go to the Userview Builder, select the permission icon of the category and choose Plugin Template - Permission for the Permission Type field. (See Figure)

Image Removed

Figure

5. Navigate to Permission Type (Plugin Template - Permission) and select Permission the template you have created, click the "OK" button and save the Userview by clicking the "Save" button. (See Figure)

Image Removed

...

For Form

1. The Form Permission plugin template created can be applied at the Form or Form Section level using the Permission Control feature.

2. For applying the Form Permission plugin template to the Form itself, go to the Form Builder of the form, select Properties, navigate to Edit Form > Advanced, and choose Plugin Template - Permission for the Permission Type field. (See Figure) 

Image Removed

Figure

3.  Navigate to Permission Type (Plugin Template - Permission) and select the template you have created and save the Form by clicking the "Save" button. (See Figure)

Image Removed

Figure

...

Properties

Edit Plugin Template Management

Image Added

Figure 10: Edit Plugin Template Management

UI

Image Added

Figure 11: UI (List) properties of Plugin Template Management

Image Added

Figure 12: UI (Add) properties of Plugin Template Management

Image Added

Figure 13: UI (Edit) properties of Plugin Template Management

UI of Plugin Template Management

UI List

Image Added

Figure 14: UI List of Plugin Template Management

UI (Add)

Image Added

Figure 15: UI (Add) of Plugin Template Management 

UI (Edit)

Image Added

Figure 16: UI (Edit) of Plugin Template Management

Plugin Types Supported as Template

The plugin types it supports as a template, for now, are as follows:

• Datalist Column Formatter
• User view / Form Permission
• Process Tool
• Form Options Binder
• Form Validator

...

Image Removed

Figure

5. Navigate to Permission Type (Plugin Template - Permission) and select the Permission template you have created, click the "OK" button and save the Form by clicking the "Save" button. (See Figure)

Image Removed

Figure

Process Tool

Steps to use the Plugin:

Form Validator

Steps to use the Plugin Template - Form Validator:

1. Launch the app "Plugin Template Demo" and create a new template again on the Plugin Template Management Page by clicking the "New" button.

2. Fill up the Plugin Template Management Page accordingly and for the "Plugin" field choose any one of the formatter under Form Validator. As we want to make the form fields "Mandatory", we have to select Default Validator. (See Figure)

Image Removed

Figure 

3. Configure the Plugin by clicking the "Configure Plugin" button. Make sure the Mandatory property is checked and save the Plugin Template by clicking the "Save" button. (See Figure)

Image Removed

Figure 

4. Enter the Design View of the Plugin Template Form.

5. Edit one of the fields in the form and navigate to Edit Text Field > Advanced Options and select Plugin Template - Validator for the Validator property. (See Figure)

Image Removed

Figure 

6. Navigate to Validator (Plugin Template - Validator) and select the template you have created and click the "OK" button. (See Figure)

Image Removed

Figure 

7. Repeat Steps 5 and 6 for as many fields as you want in the Form Builder and then save the form.

8. Launch the app and enter the Plugin Template Form page and the fields that are set with the Plugin Template will have an asterisk (*) to indicate they are mandatory fields. (See Figure)

Image Removed

...