Release a locked object

You can release a locked object to save your latest modifications to the server and unlock the file so other users can edit it. An object can only be released by the user who locked it.

About this task

In the case of a map, the Release command updates changes to the map's structure. In the case of an XML topic, the Release command validates the topic to make sure that references are correct and that the XML is well-formed. If your XML document has errors, you will be able to save it locally, but you will not be able to release it to the server.

The Release function is available from all views.

To release a locked object:

Procedure

  1. Search for and select one or more objects to release.
  2. Right-click and select Release.
  3. In the resulting Release dialog, take one of the following actions to describe the changes since the last update:
    • In the Comment field, manually enter a comment.
    • From the Choose a previously entered comment dropdown list, select a comment the you recently used when releasing another object.
    • In the Preset comments area, select one or more preset comments.
    Figure: Releasing a topic


    Note: If preset comments have not been configured, the Preset comments area are blank.
  4. Optional: If you are using a bug tracking system, such as JIRA or Bugzilla, add a bug number for each bug you fix in the Tracker link field.
    A link to the bug is added to the Release History. To add more than one bug, separate them by a comma without spaces.
  5. Optional: To update the document without releasing it, select Keep locked.
  6. Optional: Select or clear the Substantial Change checkbox.
    Note: The Substantial Change checkbox is selected by default. This checkbox flags the object as having a major change, which requires it to go through the entire review process. It must advance through each status until it reaches the final status of the workflow. This flag cannot be removed until the object completes the review process.

    However, if the changes to the object were minor, you can clear the Substantial Change checkbox. Once you clear the changes, you can move the document more directly to the final status of the workflow, depending on the configuration of your workflow, and the document will not appear in the Todo list for the assigned SMEs.

  7. Click OK.
    The document is updated in the repository of your Content Store. If you release an unchanged document, the lock is simply removed, so no new document version is created in the Content Store. If you did not keep the file locked, the file properties are displayed in black text in the various views.

    The comment you specified appears under Last User Comment in the related Todo lists, as well as other places that list file properties, such as Search Results view and DITA Map view.