resource - Fluid Topics - 3.5 - Technical Notes

Upload Unstructured Documents to Fluid Topics

Product
Fluid Topics
FT_Version
3.5
Category
Technical Notes
audience
public

Using a resource entry, it is possible to provide additional processing information for any resource, whether or not that resource is included in the archive:

Element Attribute Description
resource @lang

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

resource>originId  

An identifier that is used later for sending new instructions.

resource>filePath  

The resource you are controlling is referred to with the filePath tag using a path/filename 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 deduces the title of the document from its ft:title metadata element.

If Fluid Topics cannot deduce the title of the document, the filename is used.

resource>description  

Gives a short description of the resource.

resource>metas  

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

metas>meta  

Sets the name and value of a metadata element to associate to the document. The meta node can be repeated as many times as needed.

meta @key

Set the name of the metadata element to be displayed.

meta>value  

Set the value of the metadata element to be displayed. The value node can be repeated as many times as needed for multivalued metadata.

resource>publishStatus  

The default status value (if unspecified) is visible.

Set the status value to deleted if you want to delete a resource.

resource>rights   Sets the access level to apply to the unstructured document in Fluid Topics, and user groups to which the document access can be restricted.
rights>accessLevel   Sets the level of access to apply to the unstructured document: 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.
Note: The filePath parameter is mandatory if the document is in the archive. Otherwise, use filePath or originId to identify the document.
Tip: The values set in the Control File (metadata, names, and so on) prevail over the existing values in the resources or over values extracted from the file metadata.