...
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Plugin Template Pack aims to factorize repetitive configurations of the same plugin throughout the same app in one place to ease future maintenance. It currently supports:- with more plugin types to be supported in the future. This plugin source code is available in a new open source repository at https://github.com/jogetoss/plugin-template-pack. JogetOSS is a community-led team for open-source software related to the Joget no-code/low-code application platform. Projects under JogetOSS are community-driven and community-supported, and you are welcome to contribute to the projects. |
...
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).
Figure 2: Plugin-template-pack .jar file
...
2. Log 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 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).
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).
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
...
Edit Plugin Template Management
Figure 10: Edit Plugin Template Management
| Name | Description | |||||
|---|---|---|---|---|---|---|
| ID | The 'ID' in the property editor is a unique identifier. The value of this property is auto-generated. | |||||
| Custom ID | Item link slug. It is an Optional field.
| |||||
| Label | Menu label to be displayed to the end-user. It is a Mandatory field. |
UI
Figure 11: UI (List) properties of Plugin Template Management
| Name | Description |
|---|---|
| Button Position | The position of buttons in the Userviewuserview:
|
| Selection Type | The type record selector in the userview:
|
| Selector Position | The position of the record selector in the userview:
|
| New Record Button Label | New Record Button Label to be displayed to the end-user. Default Value: New |
| Edit Link Label | Edit Record Button Label to be displayed to the end-user. Default Value: Edit |
| Delete Button Label | Delete Record Button Label to be displayed to the end-user. Default Value: Delete |
| Custom Header | Custom Header in HTML. |
| Custom Footer | Custom Footer in HTML |
Figure 12: UI (Add) properties of Plugin Template Management
| Name | Description |
|---|---|
| Cancel Button Label | Cancel Button Label to be displayed to the end-user. Default Value: Cancel |
| Save Button Label | Save Button Label to be displayed to the end-user. Default Value: Save |
| Custom Header | Custom Header in HTML. |
| Custom Footer | Custom Footer in HTML |
Figure 13: UI (Edit) properties of Plugin Template Management
| Name | Description |
|---|---|
Back Button Label | Back Button Label to be displayed to the end-user. Default Value: Back |
| Save Button Label | Save Button Label to be displayed to the end-user. Default Value: Edit |
| Custom Header | Custom Header in HTML. |
| Custom Footer | Custom Footer in HTML |
Performance & Offline
...
Cache Settings
...
Name
...
Description
...
Caching options are:
- None: No caching is enabled. This is the default setting.
- Application: The userview page content is cached at the application level. Cache content by application where all users will see the same content.
- User: The userview page content is cached per user. This means that there is a copy of personalized content stored for each user login.
...
| borderColor | Red |
|---|---|
| titleColor | White |
| titleBGColor | #f45555 |
| borderStyle | solid |
| title | Note |
...
PWA Offline Settings
Note: PWA Offline support is dependent on the theme used.
...
Name
...
Description
...
| borderColor | Red |
|---|---|
| titleColor | White |
| titleBGColor | #f45555 |
| borderStyle | solid |
| title | Note |
...
UI of Plugin Template Management
UI List
Figure 15 14: UI List of Plugin Template Management
UI (Add)
Figure 16 15: UI (Add) of Plugin Template Management
UI (Edit)
Figure 17 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 Formatter
Steps to use the Plugin Template - Datalist Formatter Plugin:
1. Launch the app, navigate to the Plugin Template Management menu, and click the "New" button to create a new Plugin Template (See Figure 10).
Figure 10 Create a new Plugin Template
2. 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)
Figure 11 Fill up the Plugin Template details
3. Configure the plugin by clicking the "Configure Plugin" button according to Figure 12 and then submit it.
Figure 12 Configure plugin (Bean Shell Formatter) for the Plugin Template
4. Click the "Save" button to create a Plugin Template for formatting Datalists. (See Figure 13)
Figure 13 Save the new Plugin Template
5. Click the List - Plugin Template to open the design view of the Datalist builder. (See Figure 14)
Figure 14 Enter Datalist builder
6. Preview the Datalist before applying the "Plugin Template - Datalist Column Formatter" for comparing the effect of the Formatter. (See Figure 15)
Figure 15 Preview Datalist before plugin Template
7. 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)
Figure 16 Choose Plugin Template - Datalist Formatter for the "Formatter" field
8. 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)
Figure 17 Select the created Plugin Template
9. Repeat steps 17 and 18 for as many columns as you want in the Datalist and then save it.
10. Preview the Datalist to view the intended effect of the template of Plugin Template - Datalist Formatter. (See Figure 18)
Figure 18 Preview the form after Plugin Template
11. 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)
Figure 19 Columns with Plugin Template - Datalist Formatter applied
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. (See Figure)
Figure Create a new Plugin Template
...
Figure Fill up the Plugin Template details
3. Click the "Configure Plugin" button and as there are no properties to configure for this plugin, 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
...
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)
Figure Choose Plugin Template - Permission for the "Permission Type" field
3. Navigate to Permission Type (Plugin Template - Permission), select the template you have created, and save the Userview by clicking the "Save" button. (See Figure)
Figure Select the created Plugin Template
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)
Figure Choose Plugin Template - Permission for the "Permission Type" field
5. Navigate to Permission Type (Plugin Template - Permission), select Permission the template you have created, click the "OK" button, and save the Userview by clicking the "Save" button. (See Figure)
Figure Select the created Plugin Template
...
| borderColor | Red |
|---|---|
| titleColor | White |
| titleBGColor | #f45555 |
| borderStyle | solid |
| title | Note |
...
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)
Figure Choose Plugin Template - Permission for the "Permission" field
3. Navigate to Permission Type (Plugin Template - Permission), select the template you have created, and save the Userview by clicking the "Save" button. (See Figure)
Figure Select the created Plugin Template
...
...
Figure Choose Plugin Template - Permission for the "Permission" field
...
...
Figure Select the created Plugin Template
...
| borderColor | Red |
|---|---|
| titleColor | White |
| titleBGColor | #f45555 |
| borderStyle | solid |
| title | Note |
...
Process Tool
Steps to use the Plugin Template - Process Tool:
1. Launch the app "Plugin Template Demo" and create a new template again on the Plugin Template Management Page by clicking the "New" button. (See Figure)
Figure Create a new Plugin Template
...
...
...
...
Figure Map Tool to Plugin Template created
6. After clicking on the "Add/Edit Plugin" button, select Plugin Template - Process Tool. (See Figure)
Figure Choose Plugin Template - Process Tool
7. Select the Template created for your Process Tool and click submit to save your tool mapping. (See Figure)
Figure Select the created Plugin Template
...
...
Steps to use the Plugin Template - Form Options Binder:
1. Create a new Form called Country Categories from which the country select boxes of forms will populate its selections from. (See Figure)
...
...
...
2. Drag a text field into the Country Categories form, label it as Country, and make it a mandatory field.
3. Save the new form and click on Generate App to generate a CRUD for it.
4. Launch the userview, go to "Manage Country Categories" and create a few country records. (See Figure)
Figure Create New records for Country Categories
5. Create a new template again on the Plugin Template Management Page by clicking the "New" button. (See Figure)