Upload a DITA Map Attachment with a Control File - Fluid Topics - 3.7

Manage Map Attachments in Fluid Topics

Product
Fluid Topics
FT_Version
3.7
Category
Technical Notes

From Fluid Topics v3.4.55, it is possible to add a map attachment to a DITA map asynchronously by using a control file.

It is not necessary to upload content when using a control file to add a map attachment asynchronously.

  1. Create or edit the FluidTopicsControlFile.xml file according to your needs:
  2. Compress the FluidTopicsControlFile.xml file and the file(s) to attach in a ZIP archive.
  3. Upload the ZIP archive to Fluid Topics through the DITA source used to publish the DITA map.

If both the FluidTopicsControlFile.xml and the FluidTopicsDitaControlFile.xml are found in a same archive, only the FluidTopicsControlFile.xml is taken into account, and the following error message appears in the Back Office:

Another control file in the legacy format has been found in this archive (FluidTopicsDitaControlFile.xml), it will be ignored

All filepaths requested for map attachments must be absolute.

Example

My_Archive.zip
└── FluidTopicControlFile.xml
└── My_Project
└── map_attachments
└── MA.pdf

In the control file, the filepath to the MA.pdf file can be written according to one of the following templates:

<filePath>My_Project/map_attachments/MA.pdf</filePath>

OR

<filePath>/My_Project/map_attachments/MA.pdf</filePath>

OR

<filePath>./My_Project/map_attachments/MA.pdf</filePath>

The document Time Machine Configuration Guide is easier to use when it comes with a document helping users select a time zone.

To add this map attachment, the following archive is prepared:

MA_time_machine_conf_guide.zip
|_ FluidTopicsControlFile.xml
|_ map_attachments
|_ time_zones_global.pdf

The FluidTopicsControlFile.xml must be located at the root level of the archive.

The following lines show an example of how to add the map attachment to the Time Machine Configuration Guide DITA map in its variant 2.0 in the FluidTopicsControlFile.xml file:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource>
<filePath>_time_machine_conf_guide.ditamap</filePath>
<instances>
<instance>
<filePath>2.0.ditaval</filePath>
<attachments>
<attachment>
<originId>Global_time_zones</originId>
<displayName>Global Time Zones</displayName>
<filePath>./map_attachments/time_zones_global.pdf</filePath>
</attachment>
</attachments>
</instance>
</instances>
</resource>
</resources>
</controlFile>

When successfully uploading a control file (FluidTopicsControlFile.xml) through a source that is not of the Unstructured Documents type, the following information is provided in the History table of the Knowledge Hub interface: Published=0, Failed=0 and Rejected files=0. This is due to the fact that the control file is taken into account for the specified document but is not itself indexed, searchable or accessible in the Fluid Topics portal.
No failed or rejected file means that the upload was successful
More information about the upload can be consulted in the Dataflow interface of the Back Office.