Limit the Access Rights of a DITA Map to Specific Groups - Fluid Topics - 3.9 - Technical Notes

Upload DITA Content to Fluid Topics

Product
Fluid Topics
Fluid Topics Version
3.9
Category
Technical Notes
Language
English
Target Audience
public

The control file must be named FluidTopicsControlFile.xml and located at the root level of the archive.

To restrict the access rights of a DITA map to users belonging to a certain group, perform the following steps:

  1. Create a control file, or edit an existing one.
  2. In the filePath attribute of the resource element, enter the filename of the DITA map to be modified.
  3. In the accessLevel attribute of the resource element, enter the value restricted.
  4. In the groups attribute of the resource element, add the group attribute and enter the name of the group whose members are allowed to access the document.
  5. Prepare an archive containing the control file.
  6. Upload the archive through the DITA source used to publish the DITA map.

Control file template

The following lines show a template for the FluidTopicsControlFile.xml file:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource>
<filePath>map_access_rights_updated.ditamap</filePath>
<rights>
<accessLevel>restricted</accessLevel>
<groups>
<group>specific_group</group>
</groups>
</rights>
</resource>
</resources>
</controlFile>

Example

The following lines show how to limit access to the Time Machine User Guide DITA map to members of the Technicians and R&D groups using a control file:

<?xml version='1.0' encoding='utf-8'?>
<controlFile>
<resources>
<resource>
<filePath>_time_machine_user_guide.ditamap</filePath>
<rights>
<accessLevel>authenticated</accessLevel>
<groups>
<group>Technicians</group>
<group>R&D</group>
</groups>
</rights>
</resource>
</resources>
</controlFile>

Once the control file is uploaded to Fluid Topics, only users belonging to the Technicians and/or R&D groups can access the Time Machine User Guide document.

It is not necessary to include the DITA map or the DITAVAL instances in the archive.