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

File System Link

Document Link Grooper.Core

Represents a link to a file stored on the Windows file system.

Remarks

The File System Link class is a specialized type of Document Link that provides direct access to files located on disk. When a document is imported in sparse mode using an Import Provider, a File System Link is created and attached to the corresponding Batch Folder instead of copying the file into Grooper storage.

This approach is essential for high-volume or file system-based workflows, as it allows Grooper to efficiently reference and process external files without increasing repository storage requirements. File System Links expose file metadata such as creation time, last access time, last write time, and file attributes, and provide commands to load, save, move, copy, or delete the linked file.

Usage Guidance

  • Use File System Link when you want Grooper to reference files on disk without importing their content.
  • Configure the 'File Path' property to point to the absolute location of the file you wish to link.
  • Use the provided commands to load the file into Grooper, save changes back to disk, move or copy the file, or change its attributes.
  • File System Link is ideal for scenarios where documents must remain in their original location, or when rapid ingestion of large volumes is required.

Available Commands

The following commands are exposed for File System Link objects, enabling a wide range of file management and integration scenarios:

  • Load Content: Loads the external file into Grooper as a local attachment, making its content available for processing, extraction, or export.
  • Save Content: Overwrites the file on disk with the content currently stored in Grooper, supporting round-trip editing and updates.
  • Move File: Moves the file to a new directory on disk and updates the link to reference the new location.
  • Copy File: Copies the file to a specified directory, creating a duplicate while leaving the original link unchanged.
  • Delete File: Permanently deletes the file from disk and removes the link from the associated Batch Folder.
  • Change File Attributes: Sets or clears file system attributes (such as ReadOnly, Hidden, or System) to enforce policies or prepare files for further processing.

These commands can be executed manually by users or as part of automated workflows, providing flexible control over file lifecycle and integration with external systems. File System Links are essential for integrating Grooper with file system-based document management, supporting dynamic, on-demand access to document content, and optimizing storage in high-volume environments.

Properties

NameTypeDescription
General
File System Link
ContentLink
Document Link

Context Menu Commands

Command Shortcut Description
dataset_linked Change File Attributes Changes the file attributes on the linked file.
file_copy Copy File Copies the file to a directory location on the file system.
description Delete File Deletes the linked file from the file system and removes the link.
file_copy Load Content Loads the linked file and stores it locally in Grooper.
file_copy Move File Move the remote file to a new location on the file system.
file_copy Save Content Overwrites the file system content with the content stored in Grooper.
Notification