Administrators can define a document's metadata by uploading a control file synchronously.
It is also possible to update a document's metadata by uploading a control file asynchronously.
When uploading a control file asynchronously, use the same source as the content it is targeting.
The example below shows a control file that performs the following actions for a document:
- Modifies its
clusterId
. - Modifies its title.
- Modifies its description.
- Replaces the value for the
Product
metadata with a new value.
<?xml version="1.0" ?>
<controlFile>
<resources>
<resource lang="en-GB">
<filePath>path_to_document.docx</filePath>
<originId>document origin id</originId>
<clusterId>new_cluster_id</clusterId>
<title>New title</title>
<description>New description</description>
<lastEdition>2021-09-08</lastEdition>
<editorialType>article</editorialType>
<metas action="replace">
<meta key="product">
<value>New product</value>
</meta>
</metas>
</resource>
</resources>
</controlFile>
Name | Description |
---|---|
filePath |
The path to the file corresponding to the document to modify. |
originId |
A new value for the ft:originId metadata. |
clusterId |
A new value for the ft:clusterId metadata. |
title |
A new value for the ft:title metadata. |
description |
A new value for the ft:description metadata. |
lastEdition |
A new value for the ft:lastEdition metadata. |
editorialType |
A new value for the ft:editorialType metadata. |
lang |
A new value for the ft:locale metadata. |
metas |
Contains all <meta> nodes. |
replace |
An attribute that removes all the document's metadata and replaces it by new metadata. To keep the old metadata and add new metadata instead, use the append attribute. |
meta |
Adds custom metadata with key attribute as key and <value> nodes as values. |
- Topics inherit the updated metadata.
- The control file must contain one
resource
node for each document to modify. - Administrators can modify metadata beginning with the prefix
ft:
but cannot remove it. - It is necessary to name the file
FluidTopicsControlFile.xml
and place it at the root of the archive to upload.
It is also possible to use the Update/replace publication metadata web service to modify a document's metadata.