│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Document Link

Content Link Grooper.Core

Represents a link to document content stored outside of Grooper, such as a file in a file system, a document in a CMIS Repository, or an item in another external system.

Remarks

A Document Link provides a persistent reference to an external document, enabling Grooper to access, process, and manage content without duplicating file data in the repository. Document Links are typically attached to Batch Folders during import or export operations, especially when using sparse import scenarios where only a link is stored and content is loaded on demand.

The Document Link class exposes key metadata properties such as 'Filename', 'MIME Type', and 'Size', and provides methods to stream the document content as needed. This allows Grooper to efficiently handle high-volume or distributed environments, optimize storage, and support integration with external content repositories, file systems, and mail servers.

Usage Guidance

  • Use a Document Link to reference documents that must remain in external storage, or when rapid ingestion of large volumes is required without duplicating file data.
  • Configure the link properties to match the external document's location and metadata.
  • Document Links are managed automatically by Import Provider and Export Definition implementations, but can also be manipulated programmatically or via user commands.
  • When content is accessed, Grooper uses the configured connection information to authenticate and stream the file as needed.

Properties

NameTypeDescription
General
Document Link
ContentLink

Derived Types

There are 9 implementations of Document Link.

CMIS Document Link Defines a reference to a document in a CMIS Repository.
File System Link Represents a link to a file stored on the Windows file system.
FTP Link Represents a reference to a file on an FTP file server.
HTTP Link Represents a link to a resource on an HTTP server, such as a web page or file.
Mail Link Represents a reference to an email on an IMAP mail server.
PST Link Represents a link to a mail message inside a Microsoft Outlook PST file.
SFTP Link Represents a reference to a file on an SSH/SFTP file server.
Subfile Link Represents a link to a specific byte range within a parent file attachment, enabling Grooper to treat a segment of a larger file as a distinct document.
ZIP Link Defines a link to a file inside a Zip Archive stored on a parent folder.
Notification