Documented Template of a Fluid Topics Control File - Fluid Topics - 3.9 - Technical Notes

Upload Unstructured Documents to Fluid Topics

Product
Fluid Topics
Fluid Topics Version
3.9
Category
Technical Notes
Language
English
Target Audience
public

The following lines show a self-documented template of the FluidTopicsControlFile.xml file:

<?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>

The following table describes all the elements and attributes that are available for the Fluid Topics control file:

Element

Attribute

Description

resource

@lang

Defines the language of the resource, e.g., lang="en-US". If unset, Fluid Topics tries to determine the language automatically.

resource>originId

An identifier that Fluid Topics uses later to send new instructions.

resource>filePath

The path of the file in the archive.

resource>displayName

Sets the name of the resource as it will be displayed in the portal.

If this parameter is not set, Fluid Topics determines the title of the document based on the value of its ft:title metadata element.

If Fluid Topics cannot determine the title of the document, it defaults to the filename.

resource>description

Provides a short description of the resource.

resource>metas

Sets the metadata keys and values to associate with the document. Expects a meta element.

metas>meta

Sets the name and value of a metadata element to associate with the document. It is possible to repeat the meta node as many times as needed.

meta

key

Sets the metadata key and the facet name.

meta>value

Sets the value of the metadata element to be displayed. It is possible to repeat the value node as many times as needed for multivalued metadata.

resource>publishStatus

The default value of publishStatus (if unspecified) is visible.

Setting the value to deleted removes the document from the portal.

resource>rights

Sets the access level to apply to the unstructured document in Fluid Topics and sets user groups to which access can be restricted.

rights>accessLevel

Sets the level of access to apply to the unstructured document.

  • Public: The document is accessible to all users, regardless of whether they are authenticated.
  • Restricted: The document is accessible only to users from specific groups.

Note: AUTHENTICATED is not supported.

rights>groups

Sets the user groups allowed to access the document. Expects a group entry.

groups>group

Sets a user group allowed to access the document.

The filepath element is mandatory if the document is in the archive. Otherwise, it is possible to use either filepath or originId to identify the document.

The values set in the control file prevail over the existing values for the resources and over values extracted elsewhere.