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
Productmetadata with a new value.
metadata sheet
| document (filePath) | ft:clusterId | ft:description | ft:locale | ft:editorialType | ft:title | ft:lastEdition | product | |
|---|---|---|---|---|---|---|---|---|
| inheritance | yes | yes | yes | yes | yes | yes | yes | |
| path_to_document.docx | new_cluster_id | New description | en-GB | article | New title | 2021-09-08 | New product |
configuration sheet
| valuesSeparator | ; |
|---|---|
| stringTreeSeparator | | |
| metadataAction | replace |
<?xml version="1.0" ?>
<controlFile>
<resources>
<resource lang="en-GB">
<filePath>path_to_document.docx</filePath>
<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>
- Topics inherit the updated metadata.
- The control file must contain one
resourcenode for each document to modify. - Administrators can modify metadata beginning with the prefix
ft:but cannot remove it.
It is also possible to use the Update/replace publication metadata web service to modify a document's metadata.