originId - Fluid Topics - Latest

Fluid Topics Glossary

Audience
public
Version
Latest

The originId is the document's initial identifier.

For example, users can use it to:

  • Link to a document through deep links.

    For example:

    https://doc.fluidtopics.com/access?ft:originId=fluid-topics-api-reference-guide
    
  • Target a document when using the Fluid Topics web services.

    For example, using the Delete a map attachment by originId web service:

    https://doc.fluidtopics.com/api/admin/khub/maps/attachments?ft:originId=fluid-topics-api-reference-guide
    

The value of a document's originId depends on the connector through which the content was originally uploaded. The chart below describes the behavior for each connector.

A dataflow diagram illustrating various connectors and their interactions with the Fluid Topics Processing Pipeline. On the left, different sources including DITA, FTML, Author-It, Resolved Author-It, Random Content, and Files are listed. Each source feeds into its respective connector: DITA Connector, FTML Connector, Legacy Author-It Connector, Resolved Author-It Connector, Custom Connector, and Unstructured Documents Connector. The connectors process the data and split it into either a Structured Document or Unstructured Document format. Both document types are then sent to the Fluid Topics Processing Pipeline, which processes the data and sends it to the Fluid Topics Portal. Each source connector box includes details about the 'Origin ID' and relevant file paths or object IDs. The Fluid Topics Processing Pipeline creates KHUB IDs and ToC IDs based on the Origin ID and Source ID before sending the data to the Fluid Topics Portal.

In the previous chart, Resources are the map attachments and files included with the content.

Fluid Topics uses the value of a document's originId to create a document's khubId.