Updating the Access Rights of a DITA Map - Fluid Topics - 3.6

Upload DITA Content to Fluid Topics

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes

From Fluid Topics v3.4.55, the access rights of a DITA map can also be updated through the FluidTopicsControlFile.xml Control File.

Perform the following steps to update the access rights of a DITA map:

  1. Create or edit the FluidTopicsControlFile.xml control file:
    <?xml version='1.0' encoding='utf-8'?>
    <controlFile>
      <resources>
        <resource>
          <filePath>map_which_access_must_be_set.ditamap.ditamap</filePath>
          <instances>
            <instance>
              <filePath>version1.ditaval</filePath>
            </instance>
          </instances>          
          <rights>
            <accessLevel>authenticated</accessLevel>
          </rights>
        </resource> 
      </resources>
    </controlFile>
    Where:
    • resource>filePath expects the path to the DITA map file in the archive used to upload the DITA map to Fluid Topics. It can be retrieved from the Metadata Journal .
    • instance>filePath expects the path to the DITAVAL file in the archive used to upload the DITA map to Fluid Topics. It can be retrieved from the Metadata Journal .
    • rights>accessLevel expects the level of access you wish to apply to the DITA map in Fluid Topics:
      • public: The map is accessible to all users, whether they are authenticated or anonymous.
      • authenticated: The map is accessible only to authenticated users, whatever groups they belong to.
      • restricted: The map is accessible only to users from specific groups.
  2. Compress the FluidTopicsControlFile.xml file in a ZIP archive.
  3. Upload the ZIP archive to Fluid Topics through the DITA source used to publish the DITA map.
    Note: There is no need to send the DITA map nor the DITAVALs back.
Example
The following lines show how to limit the access to the Expert instance of the Time Machine Configuration Guide DITA map only to the authenticated audience:
<?xml version='1.0' encoding='utf-8'?>
<controlFile>
  <resources>                  
    <resource>
      <filePath>_time_machine_configuration_guide.ditamap</filePath>
      <instances>
        <instance>
          <filePath>Expert.ditaval</filePath>
        </instance>
      </instances>  
      <rights>
        <accessLevel>authenticated</accessLevel>
      </rights>
    </resource>
  </resources>
</controlFile>