SharePoint Document Integration Plugin

Introduction

The SharePoint Document Integration Plugin created by Mokxa Technologies, LLC extends Joget’s standard file upload capability by allowing documents to be stored and managed directly in Microsoft SharePoint instead of the Joget database or local file system. This plugin supports the complete document lifecycle, providing a seamless bridge between Joget applications and Microsoft 365 storage.

Overview Video

Plugin Specifications

• Supported Databases: MySQL, PostgreSQL
• License: Apache License, Version 2.0
• Source Code: GitHub Repository
• Joget Marketplace: SharePoint Document Integration Plugin

Key Features

• Dynamic Uploads: Upload documents to SharePoint via dynamically defined folder paths.
• Automatic Organization: Automatic folder creation within SharePoint.
• Metadata Mapping: Store and map SharePoint metadata directly into Joget forms.
• Lifecycle Management: Download, update, replace, or delete documents directly from the Joget interface.
• Native Integration: Open documents directly in SharePoint, Microsoft Teams, or local desktop applications (for supported file types such as DOCX).
• Two-Way Sync: Two-way integration and document sync (upload, replace, and delete) between SharePoint and Joget

Prerequisites

• Joget DX 9 Enterprise Edition.
• Developer/Admin access with permission to manage plugins and apps.
• Microsoft Azure AD App Registration.
• SharePoint Online Site and Document Library.
• Microsoft Graph API permissions configured for the Azure App.

Steps to Install

1. Download the plugin from the Joget Marketplace, and go to your Joget instance, either localhost or a server.
2. Navigate to Settings > Manage Plugins and upload the plugin JAR file.
3. The Joget Knowledge Base has more information on managing and developing plugins.
   

How to use it

1. Add the File Upload to External Storage element to the Form. In the Form Builder, under Mokxa Plugins, drag and drop the File Upload to External Storage element onto your form.
   
2. Configure the Basic and Advanced Settings. Configure the Display Name and Element ID. In the Advanced Options, you can define file size limits, allowed file types, mandatory validation, and specific permissions.
   
3. Next is the SharePoint Integration setup. Under the Select Storage Client dropdown, choose Microsoft SharePoint. You will need to provide the following credentials from your Azure AD App Registration:
   • Tenant ID
   • Client ID
   • Client Secret
   • Site ID and Drive ID
   • Target Upload Folder Path
4. Check the Enable Sync Files on load checkbox to enable 2-way sync between SharePoint and Joget.
   
5. Next is Metadata configuration. Select a Joget form to map SharePoint file metadata, including File ID, Name, Version, Size, and Uploaded By.
   
6. Configure Tags and descriptions. Map Joget fields to SharePoint tags and document descriptions.
   

Testing the Integration

1. Open the application containing the configured form.
2. Upload a document using the new SharePoint upload field.
3. Save the form.
4. Verify that the file appears in the designated SharePoint folder and that the metadata is correctly captured in the Joget record.

Download Sample App

Credits

This plugin and documentation are created by Mokxa Technologies, LLC.