Update 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

It is possible to update an existing map attachment by using a control file.

It is not necessary to include the DITA map in the ZIP archive or republish the content when using a control file to update a map attachment.

Example to rename a map attachment

The following example shows how to rename a document attached to a DITA map already uploaded to Fluid Topics:

  1. Create a FluidTopicsControlfile.xml control file with a new name in the displayName element.

    <?xml version="1.0" encoding="UTF-8"?>
    <controlFile>
    <resources>
    <resource>
    <filePath>my_map.ditamap</filePath>
    <instances>
    <instance>
    <filePath>version1.ditaval</filePath>
    <attachments>
    <attachment>
    <khubId>$ATTACHMENT_KHUB_ID</khubId>
    <displayName>The new name for my attachment</displayName>
    </attachment>
    </attachments>
    </instance>
    </instances>
    </resource>
    </resources>
    </controlFile>

  2. Compress the FluidTopicsControlFile.xml file in a ZIP archive.
  3. Upload the ZIP archive to Fluid Topics through the source used to publish the attachment.

Example to add a URL to a map attachment

The following example shows how to remove a URL from a document attached to a DITA map already uploaded to Fluid Topics:

  1. Create a FluidTopicsControlfile.xml control file with an originUrl element.

    <?xml version="1.0" encoding="UTF-8"?>
    <controlFile>
    <resources>
    <resource>
    <filePath>my_map.ditamap</filePath>
    <instances>
    <instance>
    <filePath>version1.ditaval</filePath>
    <attachments>
    <attachment>
    <khubId>$ATTACHMENT_KHUB_ID</khubId>
    <originUrl>http://my_target_website.com</originUrl>
    </attachment>
    </attachments>
    </instance>
    </instances>
    </resource>
    </resources>
    </controlFile>

    Note: Do not forget to add http:// or https:// at the beginning of the URL. Otherwise, Fluid Topics will not be able to resolve the URL properly.

  2. Compress the FluidTopicsControlFile.xml file in a ZIP archive.
  3. Upload the ZIP archive to Fluid Topics through the source used to publish the attachment.

Example to remove a URL from a map attachment

The following example shows how to remove a URL from a document attached to a DITA map already uploaded to Fluid Topics:

  1. Create a FluidTopicsControlfile.xml control file with an empty originUrl element.

    <?xml version="1.0" encoding="UTF-8"?>
    <controlFile>
    <resources>
    <resource>
    <filePath>my_map.ditamap</filePath>
    <instances>
    <instance>
    <filePath>version1.ditaval</filePath>
    <attachments>
    <attachment>
    <khubId>$ATTACHMENT_KHUB_ID</khubId>
    <originUrl></originUrl>
    </attachment>
    </attachments>
    </instance>
    </instances>
    </resource>
    </resources>
    </controlFile>

  2. Compress the FluidTopicsControlFile.xml file in a ZIP archive.
  3. Upload the ZIP archive to Fluid Topics through the source used to publish the attachment.

If a map attachment was added to a map using the legacy (mapping.json) method, you must use its khubId to update it with the control file method.

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.