Configure library layers for your deployment

You configure the layers for your multi-level libraries by editing the library-layers.xml configuration file.

In the initial configuration, a single layer is available ("library default layer" with the id "1") , as shown below:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE library PUBLIC "-//ixiasoft.com//cms//config//libraryLayers" "librarylayers.dtd">
<!-- ============================================================================================= --> 
<!-- --> 
<!-- FILE: librarylayers.xml --> 
<!-- --> 
<!-- DESCRIPTION: This file defines the available library layers within the docbase. --> 
<!-- Note that layer ID 0 is the Product layer and cannot be modified. Library layer IDs start at 1.--> 
<!-- --> 
<!-- ============================================================================================= --> 
<!-- REVISION HISTORY: -->
<!-- --> 
<!-- ============================================================================================= --> 
<library>
    <layer id="1" name="library" description="library default layer" isDefault="yes"/>
</library>
To configure layers, you must create a single <layer> element per layer. A layer has the following attributes:
Table 1. Attributes of the layer element
Attribute Description
id

Specifies the level of the library layer.

Note: The level must be unique within the library-layers.xml configuration file.

Library layers start at 1, the highest level. You can add as many layers as necessary. A library or product can reference content from a library that is at the same level as a sibling library, or at a lower level as a child library.
name Contains the descriptive name of the library layer. Related DRM dialogs use it to identify the layer.
description Contains a short explanation about the library layer.
isDefault Specifies the layer as the default layer.
Note: Only one layer can be set as the default, isDefault="yes".

The default layer is used for backward compatibility. When an existing library version is released, if it does not have a layer level associated to it, it is assigned this default layer.

You can add other layers, as appropriate for your deployment. Creating multiple layers increases the complexity of the IXIASOFT Dynamic Release Management.

Note: Please contact your IXIASOFT DITA specialist to help you carefully plan before implementing multi-level libraries in your deployment, since they increase the complexity of the IXIASOFT CCMS.
Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment. For dedicated SaaS deployments, test the changes and then ask IXIASOFT Customer Support to copy the changes to your production environment.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the library-layers.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. For each added layer, include the following <layer> element and then modify it to fit your deployment. 
     <layer id="<layer_level>" name="<layer_name>" description="<layer_description>" isDefault="yes|no"/>
    For example:
     <layer id="2" name="Layer 2" description="Second library layer" isDefault="yes"/>
    The following example shows the configuration for the library layers.
    <library>
    <layer id="3" name="Product Library Level" description="Product Library Level" isDefault="yes"/>
    <layer id="6" name="Third Party Library" description="Third Party Library" isDefault="no"/>
    <layer id="9" name="Operating System Library" description="Operating System Library" isDefault="no"/>
</library>
  5. Save, close, and check in the file.
  6. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIASOFT CCMS > Synchronize Configuration. Additionally, refresh IXIASOFT CCMS Web so that users will see the change reflected there.