Documented Template of FluidTopicsControlFile.xml - Fluid Topics - 3.5 - Technical Notes

Upload Unstructured Documents to Fluid Topics

Product
Fluid Topics
FT_Version
3.5
Category
Technical Notes
audience
public

The following lines display a self-documented template of a FluidTopicsControlFile.xml file.

Note: The latest version of Fluid Topics supports both the old and new versions of the FluidTopicsControlFile.xml.
<?xml version='1.0' encoding='utf-8'?>
<controlFile>
    <resources>
        <resource>
            <originId>${Identifier for the resource to upload}</originId>
            <description>${Short description of the resource that will be displayed on the portal}</description>
            <metas>
                <meta key="${Metadata used to create metadata key 1}">
                    <value>${Value of metadata key 1}</value>
                </meta>
                <meta key="${Metadata used to create metadata key 2}">
                    <value>${Value of metadata key 2}</value>
                </meta>
            </metas>
        </resource>
        <resource lang="${Lang code for the resource}">
            <originId>${Identifier for the resource to upload}</originId>
            <publishStatus>deleted</publishStatus>
        </resource>
        <resource lang="${Lang code for the resource}">
            <filePath>${COMPLETE path of the resource}</filePath>
            <displayName>${Name of the resource as it will be displayed on the portal}</displayName>
            <rights>
                <accessLevel>restricted</accessLevel>
                <groups>
                    <group>${Name of the user group the document access must be restricted to}</group>
                </groups>
            </rights>
        </resource>
    </resources>
</controlFile>
If the document is present in the archive:
  • The originId parameter is used to define an originId for the document.
  • The filePath is the only way to identify it.
If the document is not in the archive:
  • The originId can be used if it was manually defined for the document.
  • The filePath can also be used to identify the document. However the originId, if defined, takes precedence over it.
Attention: If the document is not in the archive and no originId was defined for the document, then the filePath must be used to identify the document.