📚 Document Repository

The Document Repository allows users to securely store, manage, and retrieve mission-related and arbitrary documents including reports, images, video clips, notes, etc.

Document repository

📁 Documents

A document repository can contain various types of files, categorized as:

  • Reports
  • Notes
  • Images
  • Documents
  • Videos
  • Logs
  • Misc

Documents may be associated with platforms, missions, or sensors, or they may be unassociated miscellaneous files. A document can be marked as "Restricted", which determines who has permission to edit or delete it.

🔐 Access Control & Permissions

All actions require authentication and authorization. Permissions vary by user role:

👑 Admin & SuperAdmin

  • Access: Full access to all content
  • Edit/Delete: Can edit or delete any document, including Restricted ones

👤 Regular Authenticated Users

  • Access:
  • All unrestricted documents
  • Documents belonging to their user group
  • Edit/Delete:
  • Can edit or delete only non-restricted documents

👥 GroupAdmin

  • Access:
  • Same as regular users
  • Extra Permissions:
  • Can edit a document’s Restricted attribute
  • Can delete restricted documents

📃 Document Table

Open Document repository

To open the Document repository, press Documents button.

🔎 Searching and Filtering

Users can search documents using a variety of filters:

  • By free text
  • By time
  • By tags
  • By user group membership
  • By table column values

This ensures users can efficiently locate relevant content without unnecessary clutter.

🎴 Thumbnail preview

The first column in the table contains an icon representing the document type. For images and video clips, a preview thumbnail is displayed when you hover the mouse over the icon.

📤 Uploading Documents

Documents can be uploaded via an authenticated request. Press the ✚ button to open the Create Document dialog box.

Open Document repository

You can click to select the document file (or drag and drop it), enter a name and description, and choose a document category (for images or videos, the category will be selected automatically). You can also assign user groups that will have access to the document and add metadata tags to facilitate filtering.
An Admin or GroupAdmin user can mark the document as "Restricted", preventing users without the appropriate permissions from editing or deleting it.
The system will save the file in HOST_DOCUMENTS_DIR (or DOCUMENTS_DIR, without docker), and the file metadata will be stored in the database.

🏷️ User-Defined Tags

Users can create and manage their own tags to organize and categorize content more effectively. Tags are entered as free text, giving users complete flexibility to define labels that best suit their needs. When a new tag is created, it is automatically added to the list of existing tags, allowing users to reuse it later.

🛡️ Security Classification

The Security Metadata Set is used to define the classification level of content in accordance with the MISB 0102 standard. This metadata serves as descriptive information that indicates the sensitivity of the data, helping to ensure proper handling and access control.

Allowed values for security classification are UNCLASSIFIED, RESTRICTED, CONFIDENTIAL, SECRET, TOP SECRET. The security metadata is intended for descriptive purposes and can be used to inform users, systems, or workflows of the appropriate level of protection and distribution.

🗑️ Deleting Documents

  • Admins and SuperAdmins: Can delete any document
  • GroupAdmins: Can delete restricted and unrestricted documents
  • Regular users: Can delete only unrestricted documents they have access to

Note: Deleting the document from the folder will not automatically remove the metadata from the database. Use the Delete button to delete both.

🔧 Editing Documents

Users can edit a document's metadata using the Edit Document button.
A media thumbnail is displayed for image and video document types.

Edit Document

  • Only users with proper authorization can update document attributes.
  • SuperAdmin, Admin and GroupAdmins are the only ones allowed to toggle the Restricted flag on documents.

💾 Downloading Documents

  • You can download the document by clicking the Download Document button.

✅ Best Practices

  • Always tag documents with meaningful keywords.
  • Use proper titles and descriptions for easy identification.
  • Regularly review and update document access permissions.
  • Follow your organization's security classification policies when uploading sensitive content.