Branch topics, images, or resources

This procedure describes how to branch one or more topics, images, or resources.

The object to branch must already exist in that version before you can branch it. Also, an object cannot be branched in its primary version. For example, consider a topic that exists in 3 versions: 4.1, 4.2, and 4.3. Version 4.1 is the topic's primary version. When you branch the topic, you have the option of branching it to versions 4.2 and 4.3 only.

When you branch an object, IXIASOFT CCMS does not branch the object's children. For example, if you branch a topic that includes images, the CCMS creates a new topic with the exact same content as the source topic, so both topics reference the same images.

If the parents of the object are in a closed version when you branch the object, all the parent objects will also be branched to the new version. This is because the parent of an object cannot be in a higher status than the child object. For example, a topic cannot be at the Authoring:done status if the image referenced in the topic is in Authoring:review. When you create a new instance of the object, it is created in the new version with a "work" status (or its equivalent in your workflow). When this occurs, the change in status for the object would cause a change in status for the parent objects and in the case of a closed version this is not possible. So, for example, if you branch an image from a closed version to a new version, all the topics that reference that image, and all the maps that reference those topics are also branched to the new version with a "work" status.

Important

When a topic is first created or imported into the CCMS with DRM, the filename and the id match. If a new instance of that topic is created, the id remains the same as the original, but the filename is different. Just as you cannot have two files with the same name (and extension) in a Windows directory, for example, you cannot have two objects with the same file name in the CMS repository.

However, two or more objects can have the same id. In a DRM version container, the key name is the object’s id and the key href is the object’s filename. If the id remains the same for all instances of the object, it is much more straightforward to keep the same keys defined from version to version, but simply pointing to new filenames (instances) as appropriate.
Note: You can branch multiple topics, images, or resources at the same time, if this option is enabled in your deployment. The topics, images, or resources must all belong to the same versions. If they don't, an error message is displayed.

To branch one or more topics, images, or resources:

  1. Right-click the topics, images, or resources to branch and select IXIASOFT Dynamic Release Management > Create New Instance.
  2. The next step depends on the number of versions available in which to branch the object:
    NameDescription
    If the object exists in only one version The following message is displayed:
    Selected object [object_name] exists in only one version. Cannot create new instance of it.
    Because the object exists in only one version, you cannot branch it. Add the object to the version (see "Reuse topics, images, or resources in multiple versions") and try again.
    If the object can be branched in only one version A message similar to the following is displayed:
    A new instance of the selected x objects will be created in version [xxx]. Do you want to continue?
    For example:
    Create New Instance warning

    Because the object can be branched in only one version, this version is automatically selected. To branch the element in this version, click OK.
    If multiple versions are available

    The Create New Instance dialog is displayed:

    New Instance dialog

    This dialog lists the versions that contain the object, with the exception of the primary version for this object. One version appears in the New Primary Version list, while the other versions are displayed in the All Versions area.

    Note: If you do not see the version in which you want to branch the object, add the object to that version (see "Reuse topics, images, or resources in multiple versions") and try again.

    To branch the topic:

    1. In the New Primary Version list, select the new primary version for the object.

      The object will be branched in this version, and this version will be used as the new primary version for the branched object.

    2. (Optional) To branch the object in other versions, select them in the Other Available Versions area.
    3. Click OK.

      The object is branched.
  3. If the parents of the object being branched are in a closed version, a message similar to the following is displayed: 
    A new instance will be created for the parent document in the selected primary version.

    For example:

    Create Instance of parent objects

    Because the version containing the parent objects is closed, the parent objects are branched to the new version and the new version is set as the primary version for the new instances of the parent objects. The objects in the closed version remain unchanged. To branch the objects, click OK.