Create a FluidTopicsControlFile.xml Control File - Fluid Topics - 3.5 - Technical Notes

Upload Unstructured Documents to Fluid Topics

Fluid Topics
Technical Notes

In each package you upload, you can include a Control File containing all processing instructions and metadata, which will be used to enrich your content (for example, by setting facets without modifying the source content).

Attention: If no originId is defined for the documents, then package structure must be stable over time since folder structure is used to generate Fluid Topics internal identifiers for legacy documents, but there are no restrictions on how files are organized within each package.

This Control File must be named FluidTopicsControlFile.xml, and must be located at the root level of the archive.

This file has a root node named controlFile, encompassing the resources node, encompassing itself a list of resource subnodes.

Note: The Control File can be validated using an XSD schema that is available online: Control File XSD.
Fluid Topics determines if a resource is a new resource, or a resource already existing in the Knowledge Hub that needs to be updated by comparing originId or filePath values. Therefore if you provide an originId or a filePath, it is critical that it remains consistent over time. If you did not provide one initially, Fluid Topics generates one based on the path+filename in the archive. Thus, it is recommended to follow these two rules:
  • Do not set the originId value if you did not do so the first time.
  • Do always have the file located at the same position in the archive.
Attention: The ft:originId generated by Fluid Topics cannot be used for identifying a document.

To create a FluidTopicsControlFile.xml Control File corresponding to your unstructured documents:

  1. Use the following template.
  2. Replace all ${variables} with information according to your content.

From Fluid Topics 3.5.25, the control file format specific to unstructured documents is now deprecated and replaced by a new standard. The legacy format is still supported, but it is recommended to use the new standard control file format.