-
Notifications
You must be signed in to change notification settings - Fork 310
DocumentHub - Initial Pre-Release 1.0.0 #6285
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
75498c0
d7cdcde
a48fbc3
fcce202
06e5c9e
307df5e
ab2577f
e9d5f0a
37c2f41
ac594df
1c68e5d
2d5ae8f
27b0814
8e35c0f
38a0fc7
77c9f7f
41fa1bd
c92d896
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
|  | ||
|
|
||
| > [!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**: Browse files stored in your SharePoint repository, quickly filter by name or bucket, and inspect the full metadata set for each file. | ||
|
|
||
| -  **DataMiner**: Access files stored on your DataMiner server, use name and bucket filters to narrow down results, and review all available metadata details. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the preview app I have currently installed (1.0.5-prerelease), I see a "Local" tab instead of a "DataMiner" tab. Has the name of the tab been changed since this was written? |
||
|
|
||
| -  **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**: Upload new documents to configured storage backends. Select the appropriate bucket to ensure files are stored in the correct location with proper metadata. | ||
|
|
||
| -  **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**: Connect and manage cloud storage repositories and local storage options. Configure credentials and access settings. Available to administrators only. | ||
|
|
||
| -  **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: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is any specific configuration needed to be able to store documents on the local server? Looking at the bucket creation in the preview app, I see that Local is one of the available storage types, but the app doesn't seem to accept any of the paths I have tried. |
||
|
|
||
| - 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. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
Uh oh!
There was an error while loading. Please reload this page.