Built-in metadata - Fluid Topics - Latest

Empower Metadata with Fluid Topics

Category
Technical Notes
Audience
public
Version
Latest

Built-in metadata come with a predefined metadata key that administrators cannot change. However, administrators can define one or more values for each built-in metadata key.

The characteristics of built-in metadata are as follows:

  • They associate a string value with a key.
  • They begin with ft:, such as ft:title.
  • Fluid Topics generates them automatically based on the information defined in the content.

The table includes all the built-in metadata that Fluid Topics generates for content uploaded to a tenant:

Metadata Description
ft:attachmentsSize It is the sum of the size of all attachments for a structured document. The value of ft:attachmentsSize is in bytes.
ft:baseId ID used to build links to document clusters within a topic. It is recommended to not change the ft:baseId manually and to use it when creating a deep link to a document cluster instead of using the ft:clusterId to ensure a more stable link.
ft:clusterId ID used to cluster different versions of a publication in the Search page.
ft:contentSize For structured documents, it is the sum of the size of the HTML content of all topics, and all resources. It does not include the size of attachments. For unstructured documents, it is the size of the file. The value of ft:contentSize is in bytes.
ft:description Description of a document or topic.
ft:document_type Displays the type of an unstructured document.
ft:editorialType Displays the editorial type of a map (book or article).
ft:filename Name of the file for unstructured documents.
ft:isArticle Is true for documents with ft:editorialType=article, false otherwise.
ft:isAttachment Is true for attachments, false otherwise.
ft:isBook Is true for documents with ft:editorialType=book, false otherwise.
ft:isPublication Is true if the Knowledge Hub item is a document, false for topics and attachments.
ft:isUnstructured Is true for unstructured documents, false otherwise.
ft:khubVersion Version of the processing pipeline when the document was last processed.
ft:lastEdition Last modification of the content.
ft:lastPublication Last time the document was sent to Fluid Topics.
ft:lastTechChange Last time the document was processed (published, reprocessed, updated).
ft:locale Displays a content locale (country language and region designator).
ft:mimeType Type of the unstructured document content as specified by IANA.
ft:openMode Determines whether a link opens in Fluid Topics (fluidtopics) or in an external page (external). For more information on how to use this metadata, see ft:openMode.
ft:originId Unique ID generated by the connector for a given format in a given source.
ft:outputSize For structured documents, it is the sum of the size of the HTML content of all topics, and of the size of the document and topic metadata in JSON. For unstructured documents, it is the sum of the size of the file, and of the size of the document metadata in JSON. The value of ft:outputSize is in bytes.
ft:prettyUrl Sets a URL for a document or a topic.
ft:publication_title For topics: displays the title of the publication.
ft:publicationId Unique identifier for the publication.
ft:publishStatus Determines the visibility of a document. For more information, see ft:publishStatus.
ft:searchableFrom Allows users to make a document accessible in the search results at a set date and time. For more information, see ft:searchableFrom.
ft:sourceId ID of the source in which the document or the topic was published.
ft:sourceName Name of the source in which the document was published.
ft:sourceType Type of the source in which the document was published.
ft:title Title of a document or topic.
ft:topicTitle Title of a topic.

The last edition date is different from the last publication date. For information about how Fluid Topics calculates these values, see Types of Dates in Fluid Topics.

Built-in metadata should have only one value. Multi-valued built-in metadata causes publishing errors.

Built-in metadata is sometimes referred to as semantic metadata.