Read Metadata

Reads a metadata value from a document by accessing a property on an attachment or content link.

Remarks

The Read Metadata value extractor enables you to retrieve metadata from a document by reading a property from an Attachment Type or Content Link associated with a Batch Folder. This is useful for scenarios where document-level metadata, such as file name, page count, author, or other properties, must be extracted and mapped into a data field or used in downstream processing.

How It Works

• Configure the 'Source' property to select the attachment or link type that contains the desired metadata.
• Use the 'Property Name' property to specify which property to read from the selected source.
• When executed, Read Metadata locates the source object on the Batch Folder and reads the value of the specified property.
• The extracted value is returned as a Data Instance and can be mapped to a field, used in expressions, or exported.

Configuration Guidance

• Choose the correct attachment or link type in 'Source' to ensure the property is available.
• Select a valid property name in 'Property Name' to retrieve the intended metadata value.
• Use this extractor to capture file-level or document-level metadata, such as file name, MIME type, page count, or custom properties exposed by the attachment or link type.

Usage Scenarios

• Extracting the file name or extension from a PDF, Word, or image attachment.
• Reading the page count, author, or creation date from a document's metadata.
• Capturing custom metadata fields from specialized content links or attachment types.

Diagnostics

When diagnostic logging is enabled, Read Metadata records information about the source object, property name, and extracted value. This can be used to troubleshoot configuration issues, validate property selection, and optimize extractor setup.

Properties

Name	Type		Description
Source	String	►	Specifies the Attachment Type or Content Link type which serves as the source of the metadata. ConverterSource Converter Can be one of the following types: Value Description JPEG Image Represents a JPEG image file attachment for a Batch Folder, providing access to image properties and metadata. TIFF Document Represents a TIFF document attachment for a , providing access to TIFF-specific properties and page information. ZIP Archive Represents a ZIP Archive attachment type for Batch Folders, providing access to ZIP-specific properties and commands. PDF Document Represents a PDF document attachment for a Batch Folder, providing access to PDF-specific properties, metadata, and commands. Text Document Represents a plain text file attachment type for Batch Folders, enabling text-centric processing, parsing, and integration in Grooper. EDI File Represents an EDI X12 document attachment for a Batch Folder, providing access to EDI-specific processing and normalization. XML File Represents an XML document attachment type for Batch Folders, enabling XML-specific processing, parsing, and integration in Grooper. Power Point Document Represents a Microsoft PowerPoint document, enabling presentation-centric processing, extraction, and integration in Grooper. Excel Document Represents a Microsoft Excel document, enabling spreadsheet-centric processing, extraction, and integration in Grooper. Word Document Represents a Microsoft Word document, enabling document-centric processing, extraction, and integration in Grooper. PST File Represents a Microsoft Outlook PST (Personal Storage Table) file, enabling mail-centric extraction, processing, and integration in Grooper. HTML Document Represents an HTML file attachment type for Batch Folders, enabling HTML-centric processing, parsing, and integration in Grooper. Mail Message Represents an attachment type for RFC822 and Outlook mail messages, enabling mail-centric processing, extraction, and integration in Grooper. vCard Represents an RFC6350 (vCard) object, enabling contact-centric processing, extraction, and integration in Grooper. 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. File System Link Represents a link to a file stored on the Windows file system. PST Link Represents a link to a mail message inside a Microsoft Outlook PST file. 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. SFTP Link Represents a reference to a file on an SSH/SFTP file server. CMIS Folder Link Defines a reference to a folder in a CMIS Repository. CMIS Document Link Defines a reference to a document in a CMIS Repository. The 'Source' property determines which attachment type or content link is used as the source for reading metadata. This can be a built-in type (such as PDF, Word, or image) or a custom type defined in your solution. How to Configure Use the drop-down list to select the appropriate type for your document or batch. Ensure the selected type is present on the Batch Folder and exposes the desired property. Impact Choosing the correct source type is essential for successful metadata extraction. If the source type is not present or does not expose the selected property, no value will be extracted. Examples To extract metdata from a PDF attachment (author, subject, creation date, etc.), select PDF Document as the source. To read metadata from a document stored in SharePoint (id, created, created by, etc.), select the relevant CMIS Document Link.
Property Name	String	►	Specifies the property name to be read from the Source. ConverterProperty Name Converter The 'Property Name' property identifies which metadata property will be read from the selected source type. This can be any viewable property exposed by the Attachment Type or Content Link type, such as file name, page count, author, or other metadata fields. How to Configure Use the drop-down list to select a valid property name from the available properties on the source type. Ensure the property is populated and relevant for your extraction scenario. Impact The value of the selected property will be extracted and returned as a Data Instance. If the property is empty or not present, no value will be extracted. Example To extract the creation date from a PDF Document attachment, select Creation Date as the property name. To read the object id from a CMIS Document Link, select CMIS Object Id.

Used By

Document TypeExtract FromData ColumnData FieldLexicalRules-BasedSpell CorrectorAuto Complete SettingsParagraph MarkerMetadata OptionsOCR LayerLine Periodicity DetectorFixed WidthLabeled ValueSelect PageData TypeOCR ReaderDividerAnchorSimple