Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Hitachi Content Intelligence fields

Fields prefixed with HCI_ (for example, HCI_id) have special functions. These fields might be added automatically to all documents or might be added by specific built-in stages. Additionally, when you create anindex collection, the schema for that collection is prepopulated with a number of these fields.

This table describes what the HCI_ fields are used for and how they are applied to your documents.

NoteYour system requires that every document it processes include these single-valued fields:
  • HCI_id
  • HCI_URI
  • HCI_dataSourceUuid
  • HCI_displayName
  • HCI_doc_version
These fields are added automatically to all documents.

Do not configure your pipeline stages to edit either the names or values for these fields.

Field nameDescription

HCI_accessDateMillis

HCI_accessDateString

The date and time at which the document was last accessed in the data source.

For documents added by the Local File System data connection, these fields contain the POSIX atime of the corresponding file in the local file system.

HCI_allowACL

Contains a list of users allowed to access a document.

This field is added by the Document Security stage and made use of by index collection query settings. For more information, see Configuring per-document security.

HCI_autocomplete

When users perform a simple search in the Search App, their searches are performed against values for this field. With an initially schemaless or default index collection, this field is configured to provide users with query suggestions.

For more information, see Query suggestions.

HCI_createdDateMillis

HCI_createdDateString

The date and time at which the document was created in the data source.

For documents added by the Local File System and Hadoop File System data connections, if the document's creation time is not available, these fields contain the date and time at which the document was last modified in the data source.

HCI_dataSourceName

HCI_dataSourceType

HCI_dataSourceUuid

Information about the data source from which the system read a document. Added to all documents that the system reads.
HCI_denyACL

Contains a list of users forbidden from accessing a document.

This field is added by the Document Security stage and made use of by index collection query settings.

HCI_displayNameBy default, this is the filename for a document. Added to all documents that the system reads.
HCI_doc_versionUsed by the system when rechecking a data source. Used to determine whether the document has been modified since the system last read it.
HCI_filenameThe filename for a document. Added to all documents that the system reads.
HCI_groupSIDPOSIX ID for the local file system group that owns the document.Added to documents read by the Local File System.a data connection and Hadoop File System data connection.
HCI_id

A unique string by which the system can identify a document. Added to all documents that the systemreads.

You cannot delete this field from an index collection or edit it in an index collection.

When the Workflow Agent Recursion setting is enabled for a task, the system compares this field value for a document exiting a pipeline stage to the value for the document that entered the stage. If the values do not match, the document exiting the stage was created by that stage and, as a result, sent to the beginning of the pipeline.

For more information on the Workflow Agent Recursion setting, see Task settings.

HCI_isPublicAn indication of whether a document is publicly available. This field is added by the Document Security stage and made use of by index collection query settings. For more information, see Configuring per-document security.
HCI_modePOSIX octal permissions string for a document file in the local file system. Added to documents read by the Local File System.a data connection and Hadoop File System data connection.

HCI_modifiedDateMillis

HCI_modifiedDateString

The date and time at which the document was last modified in the data source.

For documents added by the Local File System data connection, these fields contain the POSIX mtime of the corresponding file in the local file system.

HCI_namespaceThe HCP namespace where the document's corresponding HCP object exists. This field is added to documents created by the HCP (Hitachi Content Platform) data connection and HCP MQE (Hitachi Content Platform Metadata Query Engine) data connection.
HCI_operation

Indicates whether the file that corresponds to a document still exists in the data source since the last time the workflow task verified the data source. This can occur during workflow tasks where the Check for Updates setting is enabled.

If the corresponding file still exists, the value for this field is CREATED. If not, the value is DELETED.

HCI_parentDisplay

HCI_parentId

HCI_parentUri

For files produced as result of expanding an archived filed (for example, .zip), these fields identify the archive from which the file was extracted.
HCI_relativePath

The path for a document relative to the location specified by a data connection. Added by default to all documents that Hitachi Content Intelligence reads.

By default, this field is used by data connection actions to determine which files to perform actions on.

The value for this field depends on the data connection that read the document. For more information, see the topic for the data connection type you want (Data connection types and settings).

HCI_sizeThe document size. Added to all documents that the system reads.
HCI_snippet

This is the default name of the field added by the Snippet Extraction stage. Use this to store a subset of a documents contents. You can present this to your users as a summary of a document.

For more information, see Snippet Extraction stage.

HCI_text

A catch-all field for indexing all field values for a document. That is, when you create an index that's initially Schemaless or Default, all field values are copied to the multi-valued HCI_text field.

In a workflow pipeline, this field is added by the Text and Metadata Extraction stage.

HCI_triggerName

The name of a trigger that has been activated. This field is added by a trigger to the documents that the trigger sends through a trigger pipeline.

For more information, see Triggers.

HCI_ownerSIDPOSIX ID for the local file system user that owns the document.Added to documents read by the Local File System.a data connection and Hadoop File System data connection.
HCI_URIURI to the document in the data source. Added by default to all documents that the system reads.
HCI_workflowName

The name of a workflow that contains a trigger that has been activated. This field is added by a trigger to the documents that the trigger sends through a trigger pipeline.

 

  • Was this article helpful?