Joget DX 8 Stable Released
The stable release for Joget DX 8 is now available, with a focus on UX and Governance.
Table of Contents |
---|
Mayan Electronic Document Management System (Mayan EDMS) is an open-source document management platform designed for organizations to efficiently store, organize, and manage digital documents. It offers features such as document versioning, workflow automation, and secure access control.
Mayan DMS File Upload plugin allows facilitates a seamless process for users to seamlessly upload and download documents to/from Mayan EDMS. from Joget to Mayan EDMS. Once uploaded, these documents become accessible within Mayan EDMS, where users can subsequently download them as needed.. There are three components of this plugin.
This plugin is created using the REST API REST API — Mayan EDMS Documentation as as documented in the Mayan EDMS Documentation to perform RESTful API calls.
Get the plugin jar file from https://github.com/jogetoss/mayan-dms-fileupload/releases/tag/8.0.1
Upload the plugin jar file in Joget by going to Settings → Manage Plugins → Upload Plugin
The expected outcome is that users should be able to seamlessly interact with Mayan EDMS through Joget, including uploading and downloading documents, populating select boxes with data from Mayan EDMS.
The easiest way to use Mayan EDMS is by using the official Docker image. You need to have Docker properly installed and working before attempting to install Mayan EDMS.
Please follow the below instructions to set up Mayan EDMS.
Plugin Available in the Bundle:
Mayan DMS File Upload
This plugin bundle is compatible with Joget DX 8.
Upon successful configuration, Joget will have the capability to upload files to Mayan EDMS, enabling users to seamlessly upload and download documents to and from the system.
Figure 1: Example of successful integration
The prerequisite for this plugin is to have Docker installed on your system. Docker is essential because the easiest way to deploy Mayan EDMS is through its official Docker image . Before attempting to install Mayan EDMS, ensure that Docker is properly installed and operational.
a. Install Docker:
Open a terminal and run the following command to install Docker.
Code Block | ||
---|---|---|
|
wget -qO- https://get.docker.com/ | sh |
Info | ||
---|---|---|
| ||
If you |
prefer not to |
use an automated script, you can follow the installation instructions |
provided in |
the Docker documentation |
b. Download the Mayan EDMS Docker Compose files:
Mayan EDMS provides Docker Compose files for easy setup. Run the following commands to download the necessary files:
Code Block | |
---|---|
|
| |
curl https://gitlab.com/mayan-edms/mayan-edms/-/raw/master/docker/docker-compose.yml -O
curl https://gitlab.com/mayan-edms/mayan-edms/-/raw/master/docker/.env -O |
These commands will download the docker-compose.yml
and .env
files required for the Docker Compose setup.
Info | ||
---|---|---|
| ||
Please note that Administrative rights in the Command Prompt (CMD) are required to execute this action on Windows. |
c. Launch Mayan EDMS using Docker Compose:
With the Docker Compose files in place, run the following command to start Mayan EDMS:
Code Block | |
---|---|
|
| |
docker compose up --detach |
Info | ||
---|---|---|
| ||
Please refer to Installation and Additional customization |
original installation documentation and any additional customization instructions for downloading and installing the desired version for your system |
. |
After you have installed Mayan EDMS using Docker and Docker Compose on a Linux system, confirm the installation by accessing the login page.
You can login at
For this example, OpenKM is run on Docker with Linux using Docker Compose.
When you see the following page http://localhost/authentication/login/, it shows that your .
Once Mayan EDMS has been successfully hosted. Login with the automatic credentials shown in the page.
, you will be able to see the login page (see Figure 3).
You can now log in using the automatically generated credentials provided below. Typically, you will find:
admin
autoadmin@example.com
Note that these credentials will remain the same for all subsequent logins unless you update them.
Figure 3Figure 1: Mayan EDMS Login Page
After logging in with the automatically generated credentials, you will see the homepage of Mayan EDMS.
Figure 24: Mayan EDMS Homepage
To efficiently use the Joget integration with Mayan EDMS, you first need to set up your document organizational structure within Mayan EDMS. Here is how to create document types, tags, and cabinets:
Select Box→ or Load Data From → Mayan Option Binder → Mayan EDMS Settings
We are done with setting up Mayan EDMS. We will now proceed to set up this plugin in Joget.
Download the Mayan DMS Plugin Jar file here https://github.com/jogetoss/mayan-dms-fileupload/releases/tag/8.0.1.
To learn more about the plugin, you can read the documentation https://github.com/jogetoss/mayan-dms-fileupload.
Upload the plugin jar file in Joget by going to Settings → Manage Plugins → Upload Plugin
Figure 3: In the Joget Form Builder, drag and drop three select box form elements onto your form. Name them 'Document Types', 'Cabinets', and 'Tags', respectively. Then, configure each select box to use the Mayan Option Binder, which will populate them with the corresponding document types, tags, or cabinets from Mayan EDMS.
Figure 15: Joget Form Builder (Select Box with Mayan Option Binder)
Make sure to apply the basic validator In the 'Mayan EDMS Settings' section for each select box, navigate to the 'Document Types' select box.Document Types Select Box → Advanced Options → Validator → Basic
Figure 4: Mandatory select box Document typesOptions' field. Use the dropdown menu to select the option name that matches with your selectbox. This will map the respective data from Mayan EDMS with the selectbox.
For instance, for the Document types selectbox, in the options field choose document Types (Figure 16). Ensure to make this selectbox a required field.
Figure 16: Map option based on select Box (Document Types)
Similarly for 'Tag ' and 'Cabinets' selectbox, choose 'Tags' and 'Cabinets' in the Option field dropdown menu respectively.
Next, input the required credentials to all the select boxes to ensure the plugin functions properly (refer to Figure 17). These are the same username and password you use to log into Mayan EDMS, as shown in Figure 3.
Figure 17: Joget Form Builder (Select Box with Mayan Option Binder)
If you wish to avoid entering the credentials multiple times, you can add them to App variables and then use a hash variable to reference the values. For more information, please refer to App Variable.
After this, drag and drop the Mayan File Upload Element to attach into the form as a form element. More details on default configurations for file upload: File Upload - Knowledge Base for DX 8 - Joget | COMMUNITY
Below are configurations for section "Mayan EDMS Settings" in the Mayan File Upload form element
Enter the previously obtained credentials during the login process (Figure 3) for Mayan EDMS in order to establish a connection. In the Fields Mapping section, we can now map the select box fields respectively.
Figure 18: Joget Form Builder (Mayan File Upload Element)
In the datalist builder, we can format the file upload column by using the Mayan DMS File Formatter. Similar configurations can be key in to enable users to download the file directly from datalist.
Figure 19: Joget List Builder (Mayan DMS File Formatter)
Once all configurations have been completed, the user can retrieve the Document Types, Cabinets, and Tags from Mayan EDMS in the select boxes, then choose a file to upload.
Figure 20: Mayan EDMS UI (Form)
Once the file has been uploaded through the Joget, you can verify the document types, tags, and cabinets to which it has been assigned in Mayan EDMS. Additionally, the file can be directly downloaded from within the Mayan EDMS interface.
Figure 21: Mayan EDMS UI (List)
At Mayan EDMS, we can view the file being uploaded. If we modify the file here, we can also get the modified newest file in Joget.
Figure 22: Mayan EDMS Homepage with Uploaded File
To upload multiple files and other file upload features, please visit File Upload - Knowledge Base for DX 8 - Joget | COMMUNITY for further information.
If "Delete Actual File During Overwrite or Removal?" checkbox is checked, when user deletes the file, the actual file in Mayan will also get deleted.
Figure 23: Delete Actual File During Overwrite or Removal? Config
Click on remove file and save the form again.
Figure 24: Remove file and save form
You will see in Mayan that the document has been removed.
Figure 25: File removed at Mayan
At Joget, the document has also been deleted. Please note that deleting the entire record in datalist does not mean deleting file.
Figure 26: File removed at Joget
Provide the necessary credentials in the 'Mayan EDMS Settings' section for the three select boxes: 'Document Types', 'Cabinets', and 'Tags'. The credentials include the server URL where Mayan EDMS is hosted, and the username and password for an account with appropriate permissions. These details will enable the plugin to communicate with the Mayan EDMS and function as intended.
Figure 5: Joget Form Builder (Select Box Mayan EDMS Settings Configuration)
Name | Description |
---|---|
Options | Header field. |
Option * | The type of dashboard that is shown to the user.
|
Add Empty Option | Checkbox. If true, creates an empty option with label configured in next field. |
Empty Option Label | Text field to determine label for empty option. Example: "Please Select" |
Credentials | Header field. |
Server URL * | The URL that Mayan EDMS is hosted at. Example: http://localhost |
Username * | Mayan EDMS username. |
Password * | Mayan EDMS password. |
Drag and drop the Mayan File Upload Element to attach into the form as a form element. More details on default configurations for file upload: File Upload - Knowledge Base for DX 8 - Joget | COMMUNITY
Below are configurations for section "Mayan EDMS Settings" in the Mayan File Upload form element
Enter the automatic credentials previously obtained during the login process for Mayan EDMS in order to establish a connection. In the Fields Mapping section, we can now map the select box fields respectively
Figure 6: Mayan EDMS Settings for Mayan File Upload form Element
Figure 7: Mayan EDMS Settings
Name | Description |
---|---|
Credentials Credentials | Header field. |
Server URL * | The URL that Mayan EDMS is hosted at. Example: http://localhost |
Username * | Mayan EDMS username. |
Password * | Mayan EDMS password. |
Fields Mapping | Header field. |
Form * | The current form to bind the fields with. |
Document Type * | The selected form field that contains the Document Type value. |
Cabinet | The selected form field that contains the Cabinet value. |
Tag | The selected form field that contains the Tag value. |
. |
Name | Description |
---|---|
Enable File Download | Checkbox field. If true, enables file download. |
Credentials | Header field. |
Server URL * | The URL that Mayan EDMS is hosted at. Example: http://localhost |
Username * | Mayan EDMS username. |
Password * | Mayan EDMS password. |
If you wish to avoid entering the credentials multiple times, you can add them to App variables and then use a hash variable to reference the values. For more information, please refer to App Variable.
Info | ||
---|---|---|
| ||
To utilize |
the Mayan |
After all the configurations have been done, the user can retrieve the Document Types, Cabinets, and Tags from Mayan EDMS in the select boxes, then choose a file to upload.
For Instance if we create a cabinet in the Mayan EDMS, we can retrieve the Cabinets' information in the Cabinets selectbox see Figure 10.Figure 10: Displaying cabinet information from Mayan EDMS within the Joget form interface
Upload a file
Figure 11: Mayan EDMS UI (Form)
After uploading, we can download the file retrieved from Mayan in the datalist using the formatter.
Figure 12: Mayan EDMS UI (List)
At Mayan EDMS, we can view the file being uploaded. If we modify the file here, we can also get the modified newest file in Joget.
Figure 13: Mayan EDMS Homepage with Uploaded File
To upload multiple files and other file upload features, please visit File Upload - Knowledge Base for DX 8 - Joget | COMMUNITY for further information.
EDMS Plugin on Joget Cloud, it's essential to deploy Mayan EDMS on the cloud as well to ensure online accessibility. If the Mayan EDMS Plugin is hosted on the cloud while Mayan EDMS remains on a local server, Joget won't be able to access Mayan EDMS. As a result, select boxes within Joget will display empty options, impacting the intended functionality of the plugin. |