diff --git a/release-notes/DocumentHub/DocumentHub_0.3.0.md b/release-notes/DocumentHub/DocumentHub_0.3.0.md new file mode 100644 index 0000000000..49aadf0d86 --- /dev/null +++ b/release-notes/DocumentHub/DocumentHub_0.3.0.md @@ -0,0 +1,23 @@ +--- +uid: DocumentHub_0.3.0 +--- + +# DocumentHub 0.3.0 (deprecated) + +## Prerequisites + +> [!NOTE] +> This version requires: +> +> - DataMiner 10.5.9/10.6.0 or higher +> - [Standard Data Model Registration](https://catalog.dataminer.services/details/52173e49-9185-4772-9b60-c186ee365a81) 2.0.x or higher + +## New features + +#### DOM attachments support, protection of sensitive data, and filtering on bucket [ID 45319] + +The DocumentHub Solution can now list all documents that are attached to DOM instances through DOM attachments and show the linked instance. To support DOM attachments, a shared drive can be configured. + +In addition, in the backend, protection for sensitive data has been implemented so that the Azure App Registration Client Secret (for SP integration) is safely stored. + +Finally, filtering on bucket has been implemented. For each storage type, the buckets created in DocumentHub can be viewed and tested. diff --git a/release-notes/DocumentHub/DocumentHub_1.0.0.md b/release-notes/DocumentHub/DocumentHub_1.0.0.md new file mode 100644 index 0000000000..6c03c226b2 --- /dev/null +++ b/release-notes/DocumentHub/DocumentHub_1.0.0.md @@ -0,0 +1,34 @@ +--- +uid: DocumentHub_1.0.0 +--- + +# DocumentHub 1.0.0 - Preview + +> [!IMPORTANT] +> We are still working on this release. Release notes may still be modified, added, or moved to a later release. Check back soon for updates! + +## Prerequisites + +> [!NOTE] +> This version requires: +> +> - DataMiner 10.6.5 or higher +> - [Standard Data Model Registration](https://catalog.dataminer.services/details/52173e49-9185-4772-9b60-c186ee365a81) 2.0.x or higher + +## New features + +### DocumentHub: Initial functionality [ID 45528] + +The new DocumentHub application gives your team a central place to organize and access documents directly within the DataMiner platform. This initial version includes: + +- **Document buckets**: Create and manage named storage areas (called "buckets") to keep your documents organized. Each bucket can have: + - A name and description + - An upload path + - Allowed file types (e.g., only PDFs or images) + - An optional file size limit +- **File uploads**: Upload files directly from within DataMiner to your storage of choice. Three storage types are supported: + - **SharePoint**: Store documents in your organization's Microsoft SharePoint environment. + - **Local DataMiner**: Store documents on the DataMiner server. + - **DOM attachments**: Attach files directly to native DataMiner Object Model records. +- **Creation, editing, and deletion of buckets**: A guided on-screen form lets you set up or update a bucket in just a few steps, with instant validation to prevent mistakes. +- **Browsing and querying of files**: Files stored in DocumentHub can be queried and displayed in DataMiner dashboards and low-code apps. diff --git a/release-notes/DocumentHub/toc.yml b/release-notes/DocumentHub/toc.yml new file mode 100644 index 0000000000..1f5d13928a --- /dev/null +++ b/release-notes/DocumentHub/toc.yml @@ -0,0 +1,5 @@ +items: + - name: DocumentHub 1.0.0 - Preview + topicUid: DocumentHub_1.0.0 + - name: DocumentHub 0.3.0 + topicUid: DocumentHub_0.3.0 diff --git a/release-notes/Document_Hub_RNs_index.md b/release-notes/Document_Hub_RNs_index.md new file mode 100644 index 0000000000..985e759b60 --- /dev/null +++ b/release-notes/Document_Hub_RNs_index.md @@ -0,0 +1,10 @@ +--- +uid: DocumentHub_RNs_index +--- + +# DocumentHub release notes + +These release notes contain all new features, enhancements, and fixes for DocumentHub. + +> [!TIP] +> For detailed information about the DocumentHub Solution, refer to the [DocumentHub documentation](xref:DocumentHub). diff --git a/release-notes/toc.yml b/release-notes/toc.yml index c1a9f043f6..c08859e7af 100644 --- a/release-notes/toc.yml +++ b/release-notes/toc.yml @@ -39,6 +39,9 @@ items: - name: DIS release notes topicUid: DIS_RNs_index href: DIS/toc.yml + - name: DocumentHub release notes + topicUid: DocumentHub_RNs_index + href: DocumentHub/toc.yml - name: EPM release notes href: EPM/toc.yml - name: IDP release notes diff --git a/solutions/images/DocumentHub-devpack.png b/solutions/images/DocumentHub-devpack.png new file mode 100644 index 0000000000..685fd028d4 Binary files /dev/null and b/solutions/images/DocumentHub-devpack.png differ diff --git a/solutions/images/DocumentHub-internal.png b/solutions/images/DocumentHub-internal.png new file mode 100644 index 0000000000..79cf58faf5 Binary files /dev/null and b/solutions/images/DocumentHub-internal.png differ diff --git a/solutions/images/DocumentHub.svg b/solutions/images/DocumentHub.svg new file mode 100644 index 0000000000..63ce14a476 --- /dev/null +++ b/solutions/images/DocumentHub.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/solutions/images/DocumentHub_About.png b/solutions/images/DocumentHub_About.png new file mode 100644 index 0000000000..53969dcaa3 Binary files /dev/null and b/solutions/images/DocumentHub_About.png differ diff --git a/solutions/images/DocumentHub_App_Logo.png b/solutions/images/DocumentHub_App_Logo.png new file mode 100644 index 0000000000..2635c0f5e3 Binary files /dev/null and b/solutions/images/DocumentHub_App_Logo.png differ diff --git a/solutions/images/DocumentHub_App_Main_Overview.png b/solutions/images/DocumentHub_App_Main_Overview.png new file mode 100644 index 0000000000..6256052bbd Binary files /dev/null and b/solutions/images/DocumentHub_App_Main_Overview.png differ diff --git a/solutions/images/DocumentHub_App_Overview.png b/solutions/images/DocumentHub_App_Overview.png new file mode 100644 index 0000000000..4da7140849 Binary files /dev/null and b/solutions/images/DocumentHub_App_Overview.png differ diff --git a/solutions/images/DocumentHub_Buckets.png b/solutions/images/DocumentHub_Buckets.png new file mode 100644 index 0000000000..d0107e8f75 Binary files /dev/null and b/solutions/images/DocumentHub_Buckets.png differ diff --git a/solutions/images/DocumentHub_DOM.png b/solutions/images/DocumentHub_DOM.png new file mode 100644 index 0000000000..0babfc5e5f Binary files /dev/null and b/solutions/images/DocumentHub_DOM.png differ diff --git a/solutions/images/DocumentHub_DataMiner.png b/solutions/images/DocumentHub_DataMiner.png new file mode 100644 index 0000000000..19ac02366c Binary files /dev/null and b/solutions/images/DocumentHub_DataMiner.png differ diff --git a/solutions/images/DocumentHub_Settings.png b/solutions/images/DocumentHub_Settings.png new file mode 100644 index 0000000000..8d318244e5 Binary files /dev/null and b/solutions/images/DocumentHub_Settings.png differ diff --git a/solutions/images/DocumentHub_SharePoint.png b/solutions/images/DocumentHub_SharePoint.png new file mode 100644 index 0000000000..b33c3348d0 Binary files /dev/null and b/solutions/images/DocumentHub_SharePoint.png differ diff --git a/solutions/images/DocumentHub_Solution_Icon.svg b/solutions/images/DocumentHub_Solution_Icon.svg new file mode 100644 index 0000000000..b6237cfc37 --- /dev/null +++ b/solutions/images/DocumentHub_Solution_Icon.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/solutions/images/DocumentHub_Upload.png b/solutions/images/DocumentHub_Upload.png new file mode 100644 index 0000000000..62e6d10429 Binary files /dev/null and b/solutions/images/DocumentHub_Upload.png differ diff --git a/solutions/solution_index.md b/solutions/solution_index.md index fc78b56c4d..96cc96f0f9 100644 --- a/solutions/solution_index.md +++ b/solutions/solution_index.md @@ -27,12 +27,18 @@ uid: solution_index
+
+ +
+
+ +
diff --git a/solutions/standard_solutions/DocumentHub/DH_Application.md b/solutions/standard_solutions/DocumentHub/DH_Application.md new file mode 100644 index 0000000000..5957dd91a3 --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/DH_Application.md @@ -0,0 +1,123 @@ +--- +uid: DH_Application +--- + +# DocumentHub Application + +The DocumentHub app is designed for administrators and operators to manage documents, images, and files across their DataMiner environment. It provides a centralized interface for uploading, organizing, retrieving, and linking files to business operations. + +![DocumentHub Application overview](~/solutions/images/DocumentHub_App_Main_Overview.png) + +> [!TIP] +> For detailed walkthroughs on using the application, refer to the [DocumentHub application tutorials](xref:Tutorial_DocumentHub_Getting_Started). + +## Application overview + +The following sections and features are available in the app: + +- ![SharePoint](~/solutions/images/DocumentHub_SharePoint.png) **SharePoint**: Browse files stored in your SharePoint repository, quickly filter by name or bucket, and inspect the full metadata set for each file. + +- ![DataMiner](~/solutions/images/DocumentHub_DataMiner.png) **DataMiner**: Access files stored on your DataMiner server, use name and bucket filters to narrow down results, and review all available metadata details. + +- ![DOM](~/solutions/images/DocumentHub_DOM.png) **DOM**: Explore files linked to DOM records, find content by filtering on name and bucket, and view the complete metadata context used in your workflows. + +- ![Upload](~/solutions/images/DocumentHub_Upload.png) **Upload**: Upload new documents to configured storage backends. Select the appropriate bucket to ensure files are stored in the correct location with proper metadata. + +- ![Buckets](~/solutions/images/DocumentHub_Buckets.png) **Buckets**: Configure and manage document buckets. Define which file types go where, set upload restrictions, and manage metadata templates. Available to administrators only. + +- ![Source Configuration](~/solutions/images/DocumentHub_Settings.png) **Source Configuration**: Connect and manage cloud storage repositories and local storage options. Configure credentials and access settings. Available to administrators only. + +- ![About](~/solutions/images/DocumentHub_About.png) **About**: Provides information on the **version** of the DocumentHub package. + +## Uploading documents + +You can upload documents to store them in your configured storage backend. The upload process guides you through: + +1. Selecting the appropriate **document bucket**. +1. Choosing the file(s) to upload. +1. Optionally give a new name to the file +1. Confirm the upload destination. + +Once uploaded, the document will be stored in the configured backend for the selected bucket and will appear in the Documents view for all authorized users. + +## Organizing with buckets + +Document buckets streamline workflows by predefining: + +- **Name** to identify the Bucket +- **Target storage backend** (SharePoint, Google Drive, local storage, etc.) +- **Allowed file extensions** (e.g., .pdf, .jpg, .png) +- **File size limits** to prevent oversized uploads +- **Upload Location** to organize your files +- **Description** (Optional) to give some extra info about that Bucket + +Buckets help maintain organization and security by ensuring files are stored consistently and with proper restrictions. + +## Integrating with other applications + +The DocumentHub app works seamlessly with other DataMiner applications: + +- **People & Organizations**: Attach profile photos and organization logos. +- **Asset Manager**: Store and display asset images and documentation. +- **Scheduling**: Link job documents and attachments. +- **Custom Applications**: Use the [DocumentHub DevPack](xref:DH_Development) to integrate with your own low-code apps. + +Document usage is handled by the consuming application, allowing each app to control how documents are displayed and managed within its context. + +## Storage backend integration + +DocumentHub supports multiple storage backends to give you flexibility in document management: + +### SharePoint (Customer-managed) + +Connect to your organization's SharePoint repository to leverage existing document management infrastructure. Requires: + +- SharePoint site URL +- Authentication credentials (client ID and secret) +- Folder structure configuration + +### Local DataMiner Web Server + +Store documents on the local DataMiner Web Server for on-premises deployments. Ideal for: + +- Air-gapped or secure environments +- Sensitive internal documents +- High-performance local access + +### DOM Attachments with Shared Drive + +Connect to a Shared Drive in the network and store files directly on DOM instances in DataMiner. + +- Network Share Path +- Authentication credentials (username and password) +- (optionally) ISS Config for virtual webserver to have resolvable paths + +### Future integrations + +Additional cloud storage providers may be supported in future releases based on customer demand. + +## Admin capabilities + +System administrators can: + +- Configure storage backend connections and credentials. +- Create and manage document buckets. +- Set upload restrictions (file types, sizes, etc.). + +## Searching and filtering + +The Documents view includes powerful search and filtering capabilities: + +- **Search by name**: Quickly find documents by filename or title. +- **Filter by bucket**: View documents from specific buckets. +- **Filter by storage backend**: Show documents from particular storage locations. + +## Performance and scalability + +The number of documents in DocumentHub is not capped by the application itself. In practice, scalability depends on the storage capacity and performance of your selected backend, such as SharePoint or a shared drive. + +When using DataMiner Web Files in a clustered setup, keep in mind that files must be synchronized across cluster nodes. With large file volumes, this synchronization can become a bottleneck and affect overall performance. + +> [!Recommended] +> - Use DataMiner Web Files mainly for images, logos, and other lightweight documents. +> - For larger document sets or heavier files, prefer cloud storage backends (for example SharePoint) or DOM attachments. diff --git a/solutions/standard_solutions/DocumentHub/DH_Development.md b/solutions/standard_solutions/DocumentHub/DH_Development.md new file mode 100644 index 0000000000..7592289753 --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/DH_Development.md @@ -0,0 +1,11 @@ +--- +uid: DH_Development +--- + +# DocumentHub DevPack + +## About + +NuGet Class Library API to interact with DocumentHub functionality. It provides repositories and helpers for managing document buckets, SharePoint configurations, and DOM sources, as well as a high-level API for file upload and read operations across multiple storage backends. + +[DevPack repository](https://github.com/SkylineCommunications/Skyline.DataMiner.Dev.Utils.Solutions.DocumentHub) diff --git a/solutions/standard_solutions/DocumentHub/DH_Installation.md b/solutions/standard_solutions/DocumentHub/DH_Installation.md new file mode 100644 index 0000000000..b3896e3c6f --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/DH_Installation.md @@ -0,0 +1,55 @@ +--- +uid: DH_Installation +--- + +# Installing DocumentHub + +1. Look up the [DocumentHub package](https://catalog.dataminer.services/details/f9720b2e-fdaa-4956-9788-877328b587ca) in the DataMiner Catalog. + +1. Check the prerequisites mentioned in the DocumentHub [release notes](xref:DocumentHub_RNs_index) matching the package version, and make sure your system meets these prerequisites. + + > [!NOTE] + > Minimum DataMiner requirement: DataMiner 10.6.5/10.7.0. + +1. When all prerequisites are met, click the *Deploy* button. + + > [!TIP] + > For more details on deploying items from the Catalog, see [Deploying a Catalog item to your system](xref:Deploying_a_catalog_item). + +During the installation, the following steps will automatically be executed: + +1. Prerequisite check. +1. Install/Update automation scripts. +1. Install/Update applications. +1. Install/Update DOM definitions. +1. Install/update DevPack (SDM API Helpers). +1. Initialize the system (fresh install). +1. Migration actions (if any). +1. Cleanup actions (if any). + +Migration and cleanup actions are defined in the install package and will depend on the version you install. To make sure that these actions do not keep growing indefinitely over the different versions, the **migration and cleanup actions are cleaned in every major version** (e.g., from 1.x.x to 2.x.x). + +> [!IMPORTANT] +> When upgrading DocumentHub, to make sure all migration and cleanup actions take place, **first upgrade to the latest version of your current major version** before moving to the next major version, without skipping a major version. + +## Post-installation configuration + +After the installation completes, you will need to configure the DocumentHub app for your environment: + +1. Open the DocumentHub app from the [DataMiner landing page](xref:Accessing_the_web_apps#dataminer-landing-page). + +1. Navigate to the **Settings** section. + +1. Configure your storage backend: + + - Connect to your SharePoint repository, and configure your DOM attachments or use the standard DataMiner web files. + - Provide the necessary credentials and access information, if applicable. + +1. Define document **buckets** to organize file types: + + - Specify the target storage backend for each bucket. + - Define allowed file extensions. + - Set bucket rules to keep files organized. + +> [!TIP] +> Refer to the [DocumentHub application](xref:DH_Application) documentation for detailed configuration instructions. diff --git a/solutions/standard_solutions/DocumentHub/DocumentHub.md b/solutions/standard_solutions/DocumentHub/DocumentHub.md new file mode 100644 index 0000000000..ac731f9dcb --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/DocumentHub.md @@ -0,0 +1,103 @@ +--- +uid: DocumentHub +--- + +# DocumentHub + +## Centralized document management for DataMiner applications + +DataMiner DocumentHub is a comprehensive document and file management solution that can be used by DataMiner applications to store, organize, and retrieve documents, images, and other files. Whether managing job attachments, profile pictures, organizational logos, or reports, DocumentHub provides a unified, secure platform with integrated cloud storage support and metadata management. + +Designed for broadcast, service provider, satellite, and enterprise organizations, DocumentHub eliminates the need for fragmented file storage solutions across multiple applications. It centralizes all document workflows while allowing IT teams to maintain control over security, compliance, and storage backend selection. + +![DocumentHub centralized file management](~/solutions/images/DocumentHub.svg) + +## DocumentHub application + +The DocumentHub Solution is available in the [Catalog](https://catalog.dataminer.services/details/f9720b2e-fdaa-4956-9788-877328b587ca) as a package containing a [dedicated low-code app](xref:DH_Application). The solution integrates seamlessly with other DataMiner applications and also provides a NuGet API for custom application development. + +
+
+ + + +

+ DocumentHub app +

+
+
+ + + +

+ DocumentHub DevPack +

+
+
+ +> [!TIP] +> +> - Before you deploy the DocumentHub package, check the [installation instructions](xref:DH_Installation). +> - Developers integrating DocumentHub with custom applications should refer to the [DocumentHub DevPack](xref:DH_Development) documentation. +> - For details about the changes introduced in each DocumentHub version, refer to the [release notes](xref:DocumentHub_RNs_index). + +## Who can benefit from DocumentHub? + +DocumentHub serves diverse user groups across your organization: + +- **IT and security teams**: Implement centralized document management with control over storage backends, access credentials, file format restrictions, and compliance policies. The solution supports customer-managed SharePoint or on-premises storage options like DataMiner web files or DOM attachments. + +- **System administrators**: Configure document buckets for file grouping with file upload limitations, storage locations, and file extension rules. + +- **Content and asset managers**: Streamline workflows for organizing and retrieving documents across your organization. Normalize graphics formats for consistency and for automated processing. + +- **Application developers**: Integrate DocumentHub capabilities into custom DataMiner low-code apps using the NuGet API. Retrieve file information, upload documents, and manage buckets programmatically. + +- **Business operations teams**: Access documents from within operational applications such as People & Organizations, Asset Manager, and Scheduling. Attach job documents, profile images, asset photos, and service icons without leaving the application context. + +In essence, DocumentHub enables organizations to deliver better service quality, reduce fragmentation in document workflows, respond faster to business needs, and maintain compliance through centralized, secure file management. + +## What can you do with DocumentHub? + +The DocumentHub Solution simplifies document and file management across your DataMiner ecosystem. The solution provides a [ready-made application](xref:DH_Application) that can be extended with custom workflows and integrations. It can also be extended with automation scripts and user-defined APIs to integrate with your existing systems. + +DocumentHub supports the following capabilities by default without any customization: + +- **Upload and store**: Upload new documents, images, and files from user terminals to configured storage backends (SharePoint, local DataMiner web server, and DOM attachments). + +- **Link and reference**: Store file references and URLs in DataMiner DOM objects and applications. Link documents to jobs, assets, contacts, and other business entities. + +- **Search and navigate**: Discover documents by name and buckets. Browse and organize files through a unified interface regardless of storage location. + +- **Read and display**: View and open documents in third-party applications. Common file types are supported, including .jpg, .png, .gif, .svg, .pdf, .docx, .xlsx, and .pptx. + +- **Normalize and format**: Apply format conversion and normalization to graphics files at ingest to ensure consistency across standard solutions. + +- **Organize with buckets**: Create predefined document buckets to streamline workflows. Specify target platforms, allowed file extensions, and file size limits for each bucket. + +- **Integrate with APIs**: Use the DocumentHub NuGet package to develop custom integrations. Retrieve file information, manage buckets, and upload documents programmatically. + +Example use cases: + +- **People and organizations**: Profile photos and contact avatars for team members and external contacts. +- **Asset management**: Front and rear panel images of infrastructure assets, racks, and equipment. +- **Service and channel management**: Service icons, channel logos, and branding assets. +- **Scheduling and jobs**: PDF job sheets, contracts, and task documentation. +- **Cost and billing**: Generated invoices, cost reports, and financial documents. +- **Energy and utilities**: Equipment documentation, compliance certificates, and facility plans. +- **Fleet management**: Vehicle documentation, maintenance records, and operational photos. + + \ No newline at end of file diff --git a/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_DOM_NetworkShare.md b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_DOM_NetworkShare.md new file mode 100644 index 0000000000..c155ad4eb0 --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_DOM_NetworkShare.md @@ -0,0 +1,168 @@ +--- +uid: Tutorial_DH_DOM_NetworkShare +--- + +# Configuring DOM attachments on a network share + +This tutorial shows you how to configure a network share as a storage backend for DOM attachments in DocumentHub. The configuration is performed directly in the DocumentHub app's **Storage Backends** section. + +> [!NOTE] +> DOM attachments can be stored on a network share without any IIS configuration. The only mandatory requirement is that the network share is reachable by the DataMiner System. All IIS-related steps are optional and only required if you want to visualize or download attachments via a web browser. + +Expected duration: 15 minutes + +## Prerequisites + +- DocumentHub app installed and accessible +- A network share accessible from all DataMiner Agents in the cluster +- Network credentials with read/write permissions to the share +- (Optional) IIS Web Server role installed on DMAs for browser-based file access + +## Overview + +- [Step 1: Prepare the network share](#step-1-prepare-the-network-share) +- [Step 2: Configure the network share in DocumentHub](#step-2-configure-the-network-share-in-documenthub) +- [Optional: Configure browser-based access](#optional-configure-browser-based-access) + - [Create a local DataMiner user](#create-a-local-dataminer-user) + - [Configure IIS permissions](#configure-iis-permissions) + - [Create an IIS virtual directory](#create-an-iis-virtual-directory) + - [Access attachments via browser](#access-attachments-via-browser) +- [Next steps](#next-steps) + +## Step 1: Prepare the network share + +1. Verify that the network share is accessible from all DataMiner Agents in your cluster. + + Example network share location: `\\server\share` + +1. Ensure that the share has appropriate read/write permissions configured. + +1. Test connectivity from each DMA by accessing the share via Windows Explorer or command line: + + ```cmd + dir \\server\share + ``` + + > [!NOTE] + > If the share is not accessible, verify network connectivity, firewall rules, and share permissions. + +## Step 2: Configure the network share in DocumentHub + +Configure the network share directly in the DocumentHub app: + +1. Open the **DocumentHub** app in DataMiner. + +1. Navigate to the **Storage Backends** section. + + > [!TIP] + > The Storage Backends section is only visible to users with administrator permissions. + +1. Click **Add Storage Backend** or **New Backend**. + +1. Select **Network Share** or **File Share** as the backend type. + +1. Fill in the configuration details: + - **Name**: A friendly name for this backend (e.g., "DOM Attachments Share") + - **UNC Path**: The network share path (e.g., `\\server\share`) + - **Username**: The user account with access to the share (e.g., `domain\user1` or `user1`) + - **Password**: The password for the user account + - **Domain** (if applicable): The domain name + +1. Click **Test Connection** to verify that DataMiner can access the network share. + + > [!NOTE] + > If the test fails, verify that: + > - The UNC path is correct + > - The credentials have read/write permissions + > - The share is accessible from all DMAs + > - There are no firewall rules blocking access + +1. Click **Save** to store the configuration. + +1. The network share backend is now available for use with DOM attachments and document buckets. + +> [!IMPORTANT] +> DataMiner will store and retrieve attachments directly from this network location. No IIS configuration is required for basic file storage and retrieval through the DocumentHub app. + +## Optional: Configure browser-based access + +If you want users to visualize or download attachments via a web browser, follow these additional steps on each DataMiner Agent: + +### Create a local DataMiner user + +1. In DataMiner Cube, go to **System Center** > **Users / Groups**. + +1. Create a local user with credentials matching the network share credentials: + - **Username**: `user1` (matching the share account) + - **Password**: Use the same password as the network share account + + > [!NOTE] + > This user is required for IIS to impersonate when accessing the network share. + +### Configure IIS permissions + +1. On each DMA, open **Computer Management** (compmgmt.msc). + +1. Navigate to **Local Users and Groups** > **Groups**. + +1. Open the **IIS_IUSRS** group. + +1. Click **Add** and add the DataMiner user created in the previous step (e.g., `user1`). + +1. Click **OK** to save. + + > [!NOTE] + > This allows IIS to impersonate the user when accessing the network share. + +### Create an IIS virtual directory + +1. Ensure the **IIS Web Server** role is installed on the DMA. + +1. Open **IIS Manager** (inetmgr). + +1. Expand the server node and navigate to the **Default Web Site**. + +1. Right-click **Default Web Site** and select **Add Virtual Directory**. + +1. Configure the virtual directory: + - **Alias**: `shareRedirect` (or another name of your choice) + - **Physical path**: `\\server\share` (the network share UNC path) + +1. Click **OK**. + +1. Select the newly created virtual directory in IIS Manager. + +1. Double-click **Basic Settings** in the Actions pane. + +1. Click **Connect as...** and configure the virtual directory to use the local DataMiner user credentials: + - **User name**: `user1` + - **Password**: The user's password + +1. Click **OK** to save. + +1. Click **Test Settings** to verify the configuration. + +### Access attachments via browser + +Once IIS is configured, attachments can be accessed via a web browser using the following URL format: + +``` +https:///shareRedirect/ +``` + +Example: `https://dma.example.com/shareRedirect/document.pdf` + +> [!TIP] +> The DocumentHub app can automatically generate these URLs for DOM attachments when the IIS virtual directory is configured. + +## Next steps + +After configuring the network share backend, you can: + +- Create document buckets that use this network share +- Configure DOM definitions to store attachments on this share +- Upload documents to the network share through the DocumentHub app +- Link DOM attachments to jobs, assets, and other business entities + +> [!TIP] +> For more information on creating and managing document buckets, see [DocumentHub app](xref:DH_Application). diff --git a/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_SharePoint.md b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_SharePoint.md new file mode 100644 index 0000000000..4b9c0723dc --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DH_SharePoint.md @@ -0,0 +1,128 @@ +--- +uid: Tutorial_DH_SharePoint +--- + +# Configuring SharePoint as a storage backend + +This tutorial shows you how to configure SharePoint as a storage backend for DocumentHub. The configuration is performed directly in the DocumentHub app's **Storage Backends** section. + +> [!NOTE] +> This tutorial uses SharePoint with Azure AD (Microsoft Entra ID) authentication. You will need administrative access to Azure Portal to complete the setup. + +Expected duration: 15 minutes + +## Prerequisites + +- DocumentHub app installed and accessible +- Access to Azure Portal with permissions to register applications +- SharePoint site with appropriate permissions + +## Overview + +- [Step 1: Register your app in Azure AD](#step-1-register-your-app-in-azure-ad) +- [Step 2: Generate a client secret](#step-2-generate-a-client-secret) +- [Step 3: Configure API permissions](#step-3-configure-api-permissions) +- [Step 4: Configure SharePoint in DocumentHub](#step-4-configure-sharepoint-in-documenthub) +- [Next steps](#next-steps) + +## Step 1: Register your app in Azure AD + +1. Navigate to [Azure Portal](https://portal.azure.com) and sign in. + +1. Go to **Microsoft Entra ID** > **App Registrations**. + +1. Click **New Registration** and provide a descriptive name (e.g., "DataMiner DocumentHub"). + +1. Set the redirect URI to your DataMiner application domain. + +1. Click **Register**. + +1. Note down the following values (you will need them later): + - **Application (client) ID** + - **Directory (tenant) ID** + +## Step 2: Generate a client secret + +1. In your app registration, navigate to **Certificates & Secrets** in the left menu. + +1. Click **New client secret**. + +1. Provide a description and select an expiration period. + +1. Click **Add**. + +1. **Important**: Copy the client secret value immediately. It will not be shown again. + + > [!WARNING] + > Store the client secret securely. You will need it when configuring DocumentHub. + +## Step 3: Configure API permissions + +1. In your app registration, go to **API permissions**. + +1. Click **Add a permission**. + +1. Select **Microsoft Graph**. + +1. Choose **Application permissions**. + +1. Add the following permissions: + - **Sites.ReadWrite.All**: Allows the app to read and write items in all site collections. + - **Files.ReadWrite.All**: Allows the app to read and write files in all site collections. + +1. Click **Add permissions**. + +1. Click **Grant admin consent** for your organization. + + > [!NOTE] + > You must have administrator privileges to grant consent. + +1. Confirm that the permissions show "Granted" status. + +## Step 4: Configure SharePoint in DocumentHub + +Now that you have completed the Azure AD setup, configure SharePoint in the DocumentHub app: + +1. Open the **DocumentHub** app in DataMiner. + +1. Navigate to the **Storage Backends** section. + + > [!TIP] + > The Storage Backends section is only visible to users with administrator permissions. + +1. Click **Add Storage Backend** or **New Backend**. + +1. Select **SharePoint** as the backend type. + +1. Fill in the configuration details: + - **Name**: A friendly name for this backend (e.g., "Corporate SharePoint") + - **Tenant ID**: The Directory (tenant) ID from Step 1 + - **Client ID**: The Application (client) ID from Step 1 + - **Client Secret**: The client secret value from Step 2 + - **Site URL**: Your SharePoint site URL (e.g., `https://yourtenant.sharepoint.com/sites/yoursite`) + - **Document Library**: The name of the document library to use (e.g., "Documents") + +1. Click **Test Connection** to verify the configuration. + + > [!NOTE] + > If the test fails, verify that: + > - The credentials are correct + > - API permissions have been granted + > - The SharePoint site URL is accessible + > - The document library exists + +1. Click **Save** to store the configuration. + +1. The SharePoint backend is now available for use in document buckets. + +## Next steps + +After configuring SharePoint, you can: + +- Create document buckets that use this SharePoint backend +- Configure metadata templates for SharePoint-stored documents +- Upload documents to SharePoint through the DocumentHub app +- Integrate SharePoint storage with other DataMiner applications + +> [!TIP] +> For more information on creating and managing document buckets, see [DocumentHub app](xref:DH_Application). diff --git a/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DocumentHub_Getting_Started.md b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DocumentHub_Getting_Started.md new file mode 100644 index 0000000000..c76ec94a6d --- /dev/null +++ b/solutions/standard_solutions/DocumentHub/Tutorials/Tutorial_DocumentHub_Getting_Started.md @@ -0,0 +1,10 @@ +--- +uid: Tutorial_DocumentHub_Getting_Started +--- + +# Getting started tutorials + +| Name | Description | +|--|--| +| [Configuring DOM attachments on a network share](xref:Tutorial_DH_DOM_NetworkShare) | This tutorial shows you how to configure a network share as a storage backend for DOM attachments in DocumentHub. | +| [Configuring SharePoint as a storage backend](xref:Tutorial_DH_SharePoint) | This tutorial shows you how to configure SharePoint as a storage backend for DocumentHub. | \ No newline at end of file diff --git a/solutions/toc.yml b/solutions/toc.yml index 6d2159a0c5..d66bbafdcb 100644 --- a/solutions/toc.yml +++ b/solutions/toc.yml @@ -175,6 +175,22 @@ items: topicUid: Jobs_Page - name: Web File Manager topicUid: Web_File_Manager + - name: DocumentHub + topicUid: DocumentHub + items: + - name: Installing DocumentHub + topicUid: DH_Installation + - name: DocumentHub app + topicUid: DH_Application + - name: DocumentHub DevPack + topicUid: DH_Development + - name: Tutorials + topicUid: Tutorial_DocumentHub_Getting_Started + items: + - name: Configuring SharePoint as a storage backend + topicUid: Tutorial_DH_SharePoint + - name: Configuring DOM attachments on a network share + topicUid: Tutorial_DH_DOM_NetworkShare - name: PTP topicUid: SolPTP items: