im unlock
unlocks a document
Synopsis
im unlock [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] issue id...
Description
im unlock unlocks a locked document. To unlock a document, you (or a group to which you belong) must have a lock on it or you must be part of the Lock Administrator group.
Normally, when a document is unlocked, any user can edit the lockable fields of that document. However, the administrator can configure Windchill RV&S to require users to lock a document before they edit the lockable fields of that document. When such a requirement is in place, no one can edit the lockable fields of an unlocked document.
Examples
For example, the current user is a member of the Reviewers groups. Consider the following documents:
• Document 100 is a Windchill RV&S document of a type that uses locking. It is locked by the current user. Locking is not required to edit this document.
• Document 200 is a Windchill RV&S document of a type that uses locking. It is locked by the Reviewers group. Locking is required to edit this document.
• Document 300 is a Windchill RV&S document of a type that uses locking. It is locked by the Publishers group. Locking is required to edit this document.
Specifying:
im unlock 100
attempts to unlock Document 100. This succeeds because it is locked by the current user. Any user can now edit the lockable fields of this document.
Specifying:
im unlock 200
attempts to unlock Document 200. This succeeds because the current user belongs to the group that has the document locked. No user can now edit the lockable fields of this document without locking it first.
Specifying:
im unlock 300
fails because the current user does not belong to the group which has the document locked.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• issue id...
the ID of the document you are unlocking. To specify more than one document, use a space separated list.
See Also