Document Fields

The connector adds the following fields to each document that it ingests:

Field Name 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.
AUTN_MODIFICATIONS

Provides information about how many times an item has been modified. For example:

<AUTN_MODIFICATIONS modified="3" modified_history="FO9"/>

This field is not supported by all connectors, so it might not be present, and might not include all of the attributes described below:

  • modified - the number of modifications that have been observed by the connector. This might be a minimum number; if an item is modified more than once between synchronize cycles the connector might only observe a single change (this depends on the information available from the repository).
  • modified_history - the time intervals between recent modifications (up to 50, one character per interval, with the most recent change at the end of the list).

    To convert a character into a time duration:

    1. Convert the character to an integer, n, (0 to 61) by the position in this string: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz.
    2. Calculate using floating point arithmetic (13/9)n.
    3. Read the resulting number as a number of seconds giving the minimum duration. Due to rounding the actual value will be in the range (13/9)n to (13/9)(n+1).

    For example, to read "F":

    • n=15, because "F" is the 16th character in the string above.
    • (13/9)15 = (1.44444...)15 = 248.6...This gives a minimum duration of 0:04:08. The full range would be 248.6 to 359.1 seconds, or a duration between 0:04:08 and 0:05:59.
  • attributesmodified - the number of times the attributes of a file have been modified. This might be a minimum number; if an item is modified more than once between synchronize cycles the connector might only observe a single change (this depends on the information available from the repository).
  • attributesmodified_history - the time intervals between attributes being modified. This field has the same format as modified_history.
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.