Locks prevent multiple people from editing the same artifact
at the same time. When you edit an artifact, it is automatically locked.
In the web client, a lock icon (
) is displayed in the editor toolbar while you edit. If you click
, the artifact remains locked because it is still in editing mode.
However, when you click Done
, the artifact is unlocked and saved. Then, the
unlocked icon (
) is displayed on the artifact editor toolbar. When an artifact is locked, a lock icon is
displayed next to the artifact on the Artifacts
page. If an artifact is locked
by another user, you can hover over the icon to see who locked the artifact.
Note: Users can add
tags, comments, and links when an artifact is locked for editing, or manually locked.
If you have certain permissions, you can manually lock and unlock artifacts, including modules
and collections. When you manually lock an artifact, it remains locked until you unlock it, even if
you are not actively editing it. Manual locks can be useful for preventing other users from editing
an artifact for an extended time. For more information about permissions, see Permissions for Requirements Management (RM) projects.
Locks in configuration management
You can work for enabled project in configuration
management. If you lock an artifact either manually or automatically, the artifact is locked
in the current stream.
You need certain permissions to manually lock artifacts and to override someone else's lock. You
might override a lock when you must edit a locked artifact or when artifacts are locked by users who
can no longer unlock them.
Warning: If you override a lock, you might cause save
conflicts or prevent users from saving their work. The ability to override locks is primarily used
to unlock an artifact when the user who locked the artifact cannot unlock it. If you are an
administrator, grant permission to override locks sparingly.
Locked modules and collections
In a locked
module or collection, you cannot add or remove artifacts unless you
have permission to override locks. In addition, you cannot restructure
the artifacts in a locked module. However, you might still be able
to modify the artifacts that are in the module or collection. The
ability to modify the artifacts is governed by the locks on the artifacts
Sorting and filtering artifacts by lock status
In the web client, you can create a filter or change the column settings to display lock
information. For example, to create a filter that displays locked artifacts, on the
page, filter the artifacts by attribute, and then select the
For more information about creating filters, see Filters and views for artifacts in requirements projects
In addition, you can change the columns in a view
to display who locked an artifact or module and when it was locked.