Documented Examples of a Fluid Topics Control File - Fluid Topics - 3.11

Upload Unstructured Documents to Fluid Topics

Version
3.11
Category
Technical Notes
Audience
public

Upload a PDF to Fluid Topics

The following lines show the FluidTopicsControlFile.xml file used to upload a PDF file named time_machine_assembly.pdf, stored under the /Users/johndoe/OLEANDOR directory tree, to Fluid Topics:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource lang="en-US">
<filePath>/Users/johndoe/OLEANDOR/time_machine_assembly.pdf</filePath>
<displayName>OD1000 Time Machine Assembly</displayName>
<description>This document presents the assembly of the OD1000 Time Machine parts.</description>
<metas>
<meta key="product">
<value>OD1000</value>
</meta>
</metas>
</resource>
</resources>
</controlFile>

The filePath value is using a Unix file system path, i.e., it uses a "/" between each level in the directory.

Once published to Fluid Topics, the document is displayed in the Search page as follows:

An unstructured document with its description in the Search page

Where:

  • The title is the same as that defined in the Fluid Topics control file. If none is defined, the filename is displayed.
  • The product metadata associated with the document is displayed as a tag below the document's title.
  • The description defined in the Fluid Topics control file is displayed when submitting an empty search query or if no word in the document content matches the search query.

If a word in the document matches the search query, the matching content is displayed instead of the description. For example, after submitting the search query "continuum", the following excerpt appears and the matching keyword is highlighted:

An unstructured document in the Search page with a keyword match

Upload a Video File to Fluid Topics

Since Fluid Topics is not a streaming platform. uploading many video files as unstructured documents may cause performance issues. It is recommended to use a dedicated streaming platform and integrate video content into Fluid Topics in HTML format.

It is nonetheless possible to upload a video file as an unstructured document by configuring the Fluid Topics Control File as in the following example:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource lang="en-US">
<filePath>/Users/johndoe/OLEANDOR/time_machine_demonstration.pdf</filePath>
<displayName>Time Machine Demonstration</displayName>
<description>This video presents a demonstration the OD1000 Time Machine.</description>
</resource>
</resources>
</controlFile>

The filePath value is using a Unix file system path, i.e., it uses a "/" between each level in the directory.