FTP Link

Specifies the path to the file on the FTP server, relative to the base directory defined by 'Server Uri'. This value is used by Grooper to locate and access the external document when performing operations such as loading, saving, or deleting content.

The 'Relative File Path' must match the exact location of the file as it appears within the FTP server's directory structure. For example, if the file is located in a folder called invoices/2024 and is named invoice.pdf, set this property to invoices/2024/invoice.pdf.

Returns the MIME type associated with the file referenced by this link, based on its extension. This value is used by Grooper to determine how to process, display, or export the file.

For example, a file with the extension .pdf will have a MIME type of application/pdf.

This property is read-only and is determined automatically from the file extension.

Returns the path to the file as configured in the 'Relative File Path' property. This value is used internally by Grooper and is also available for expressions, reporting, and export scenarios.

This property is read-only and reflects the current configuration of the link.

The 'Error Message' property is populated if Grooper encounters an error when accessing, loading, or updating the external content referenced by this link. This can help diagnose connectivity issues, permission problems, or missing content in external systems.

Specifies the base URI of the FTP server where the external file is stored. This value is required to establish a connection and authenticate with the server.

Examples: ftp://files.example.com/ftp://192.168.1.100/

The 'Server Uri' should point to the root directory under which the 'Relative File Path' is resolved.

Specifies the account name used to authenticate with the FTP server. This user must have permission to access the file specified by 'Relative File Path' and perform the required operations (read, write, delete).

The 'User Name' is used in conjunction with the 'Password' property to establish a secure connection.

Specifies whether SSL encryption should be enabled when connecting to the FTP server. Enabling SSL is recommended for secure transmission of credentials and file data, especially when working with sensitive or confidential documents.

Set this property to true to use FTPS (FTP over SSL/TLS), or false to use standard FTP.

Returns the file name portion of the 'Relative File Path', excluding any directory information. This value is useful for display, logging, and when exporting or processing files.

For example, if 'Relative File Path' is invoices/2024/invoice.pdf, 'Object Name' will be invoice.pdf.

This property is read-only and is derived automatically from the configured file path.

The 'Link Name' distinguishes this Content Link from others attached to the same Batch Folder. Common values include "Import" for links created during import, and "Export" for links created during export. This property is used to track the origin or purpose of the link, and is referenced by the 'ImportLink' and 'ContentLink' properties on Batch Folder.

The 'Path' property returns the directory or container path of the external content, excluding the item name itself. This is useful for understanding the organization of content in external systems, and for display or navigation purposes.

If available, this property provides the user or account that originally created the external content. This information is typically populated for repository-based links (such as CMIS Repository), and may be null for file system links.

Indicates when the external content was originally created. This value is useful for auditing and tracking purposes, and is populated when available from the external system.

If available, this property provides the user or account that most recently modified the external content. This is typically available for repository-based links, and may be null for file system links.

Indicates the last modification date and time for the external content. This value is useful for tracking changes and is populated when available from the external system.

Returns the date and time when the file was last written to on the FTP server. This value is useful for tracking updates, detecting changes, and managing document lifecycles.

This property is read-only and is retrieved from the FTP server metadata.

The 'Filename' property provides the name of the external file referenced by this Document Link, excluding any directory information. This value is useful for display, logging, and when exporting or processing files.

The filename is typically derived from the external file's path and is used throughout Grooper to identify the document in user interfaces, reports, and export operations.

For example, if the external file path is /invoices/2024/invoice.pdf, the 'Filename' will be invoice.pdf.

This property is read-only and is determined automatically from the linked file.

The 'MIME Type' property indicates the media type of the external document, such as application/pdf or image/tiff. This value is used by Grooper to determine how to process, display, or export the file.

The MIME type is typically inferred from the file extension, but may also be set explicitly by the import or export provider.

Correct configuration of the MIME type ensures that the document is handled appropriately throughout the Grooper workflow, including extraction, conversion, and export scenarios.

The 'Size' property provides the total size of the external document referenced by this Document Link, measured in bytes. This value is useful for storage planning, validation, and reporting.

The size is determined from the external file's metadata and is updated whenever the link is refreshed or the file is modified.

For example, a 2 MB PDF file will have a 'Size' value of 2,097,152 bytes.

This property is read-only and always reflects the current size of the file as reported by the external system.