Additional requirements - Fluid Topics - Latest

Fluid Topics Control File

Category
Technical Notes
Audience
public
Version
Latest

To determine if a resource is new or if it already exists in the Knowledge Hub, Fluid Topics compares the values of either the originId or the filePath metadata in the control file.

For this reason, it is necessary to respect the following requirements when creating a Fluid Topics control file:

  • The values of the originId or the filePath metadata must remain stable over time.
  • The structure of the archive must remain stable over time.
  • If no originId is defined for the documents, all document filenames must be unique.
  • If no originId is defined when preparing the archive for the first upload, it is recommended to not define one afterward.

It is possible to upload a control file in the same archive as the content (synchronous upload) or on its own (asynchronous upload). When uploading the control file synchronously, the following requirements apply:

  • The filePath field is mandatory.
  • If the filePath is not defined, the associated resource node is considered as if the control file was uploaded on its own.

When uploading the control file asynchronously, the filePath field is not mandatory if the originId field is set.