Connector Framework Server 12.11

# Document Fields

The following fields are added to a document by connectors:

Field | Description
--- | ---
`AUTN_IDENTIFIER` | An identifier that allows a connector to extract the document from the repository again, for example during the collect or view actions. For more information about the identifier, see AUTN_IDENTIFIER.
`DocTrackingId` | An identifier used for document tracking functionality.
`DREREFERENCE` | A reference for the document. This is the standard IDOL reference field, which is used for deduplication.
`source_connector_run_id` | (Added only when `IngestSourceConnectorFields=TRUE`). The asynchronous action token of the `fetch` action that ingested the document.
`source_connector_server_id` | (Added only when `IngestSourceConnectorFields=TRUE`). A token that identifies the instance of the connector that retrieved the document (different installations of the same connector populate this field with different IDs). You can retrieve the UID of a connector through `action=GetVersion`.

The following fields are added to a document during ingestion:

Field | Description
--- | ---
`DocumentAttributes` | KeyView document attributes.
`DocumentClass` | The KeyView document class. Consult the KeyView Classes table to determine the file class that was imported.
`DocumentSize` | The size of the document.
`DocumentType` | A number that represents the program that created the file format. Consult the KeyView Supported Formats table to determine the file type that was imported.
`DRECHILDCOUNT` | The number of sub-files that the document contains.
`DREDBNAME` | The name of the IDOL database that the document must be indexed to.
`DREFILENAME` | The file name of the original document.
`DREORIGINALNAME` | The original file name passed to CFS. This is the full path for extracted sub-files.
`DREROOTFAMILYREFERENCE` | The parent document for the family of documents.
`DREROOTFAMILYREFERENCE_ID` | A unique hash for the family of documents.
`FAMILYSORT` | A field used to track families (that is, containers) of documents. It contains a hash unique to the family, with indices appended that describe the depth and number of attachments.
`ImportErrorDescription` | If an error occurs when a document is processed, a description of the error is written to this field.
`ImportMagicExtension` | The file extension of the detected document type.
`ImportOriginalEncoding` | The detected encoding used by the document.
`ImportVersion` | Internal version number.
`InfoFlag` | A KeyView Flag that describes the file type (External, Embedded and so on). 0 = default 1 = This sub file needs further extraction 2 = This sub file is protected 4 = This sub file is an external file 8 = This sub file is a mail item attachment 16 = This sub file is SMIME protected
`KeyviewVersion` | The version of KeyView that CFS was released with.
`UUID` | A unique identifier for the document.
`VersionNumber` | The version of CFS that was used to import the document.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.11 | Last updated February 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Connector Framework Server 12.11

Topic Title: Document Fields