This topic describes the following document-related actions and their effect on the version status of a document:
|
|
Users can perform these actions only if they have the required permissions. See the Security Guide for more information.
Checking out the current version of a document:
In other words, only the current version can be checked out, and while it is checked out no one else can check it out again.
There are two types of checkout, exclusive and collaborative. One of these two will be the default for the object store; if the client application does not allow the user to specify the checkout type, then the default will apply. Note that the checkout type is not a property of the document, but is one of two ways that you can perform a check out:
When you checkout a document, Content Engine makes a copy of the current version's content with the version status of reservation and increments the minor number. You can download the document to edit it. When you have finished editing, you can checkin the document. Content Engine saves the checked in document as the current version, with its own new content, and either keeps the reservation Minor number or changes the version to the next Major version number in the version series.
Whenever you check out a document, Content Engine ensures that you are always working with the latest version of the document. The version history of your documents is protected. When you check out a document to work on it, Content Engine delivers a copy of the content and not the original document content. This copy of the earlier version becomes the content file of the new version, if you decide to check it in. You could also choose to cancel the checkout or checkin a different file. The object store retains the original content along with its descriptive document object as a protected version in that document's version series.
See Check out document for how to use Enterprise Manager to check out a document.
Checking in the Reservation object:
Enterprise Manager, Workplace XT, and Workplace let you check in documents as Major or Minor versions.
This sequence table shows examples of the checkout and checkin cycle. Red text denotes the change from the row preceding:
Versioning actions | Versions created | |||
---|---|---|---|---|
First version | Second version | Third version | ||
1 | Check in first document as Minor | Version #: 0.1 Status: In Process Current version |
||
2 | Check out | Version #: 0.1 Status: In Process Current version |
Version #:
0.2 Status: Reservation |
|
3 | Check in as Minor | Version #: 0.1 Status: Superseded |
Version #: 0.2 |
|
4 | Check out | Version #: 0.1 Status: Superseded |
Version #: 0.2 Status: In Process Current version |
Version #: 0.3 Status: Reservation |
5 | Check in as Major | Version #: 0.1 Status: Superseded |
Version #: 0.2 Status: Superseded |
Version #: 1.0 Status: Released Current version |
See Check in document for more information.
Canceling a checkout:
Administrators can cancel the checkouts of other users. You might find this feature useful if a user has left the company and has not checked in all his or her documents.
This sequence table shows examples of canceling a checkout. Red text denotes change from the row above:
Versioning actions | Versions created | ||
---|---|---|---|
First version | Second version | ||
1 | Create document. | Version #:
0.1 Status: In Process Current version |
|
2 | Check it out. | Version #: 0.1 Status: In Process Current version |
Version #:
0.2 Status: Reservation |
3 | Cancel checkout. This deletes the Reservation. | Version #: 0.1 Status: In Process Current version |
|
See Cancel checkout for more information.
Promoting a Minor version converts it into the released Major version.
You can only promote the current In Process version. You cannot promote a document that is already a Major version, that is a Reservation object, or that is Superseded. Promote is allowed on frozen versions and on documents based on a versioning-disabled class.
If a document is successfully promoted, its Version Status is set to Released, and its Major version number is incremented by 1, and its Minor version number is set to zero. Also, the previous major version's Version status becomes Superseded.
If the document has a security policy applied, and if that security policy has templates for Released or Superseded, those templates are automatically applied to those versions.
The following portion of the full sequencing table shows what happens when you promote a document; red text denotes change from the row above:
Versioning actions | Versions created | ||||
---|---|---|---|---|---|
First version | Second version | Third version | Fourth version | ||
8 | Check in: Dave checks in his document as a Minor version. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Released |
Version #: 1.1 Status: Superseded |
Version #: 1.2 Status: In Process Current version |
9 | Promote: The group reviews the document and decides it's ready to be released. Alice promotes the current version to Released. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Superseded |
Version #: 1.1 Status: Superseded |
Version #: 2.0 Status: Released Current version |
See Promote document for more information.
Demoting the Major Released version of a document converts it into the current In Process Minor version, and sets the most recent Superseded Major version, if one exists, as the Released Major version. For example, suppose you discover a mistake in your current Released document, version 2.0 You can demote that document and now the Superseded version 1.0 becomes the Released document. The demoted version is now the Current Minor version so you could check it out for edits again. Note Demote does not delete any versions or content out of the version series. It just updates properties so that the previous Major version is now the current Major version.
Demote is allowed on frozen versions and on documents based on a versioning-disabled class.
The following portion of the full sequencing table shows you what happens when you demote a document; red text denotes change from the row above:
Versioning actions | Versions created | ||||
---|---|---|---|---|---|
First version | Second version | Third version | Fourth version | ||
9 | Promote: The group reviews the document and decides it's ready to be released. Alice promotes the current version to Released. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Superseded |
Version #: 1.1 Status: Superseded |
Version #: 2.0 Status: Released Current version |
10 | Demote: Later, the company decides to revert to an earlier policy. Alice demotes the Released document, which makes the earlier major version the Released version. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Released |
Version #: 1.1 Status: Superseded |
Version #:
1.2 Status: In Process Current Version |
See Demote document for more information.
Users with the correct permissions can delete a version out of the middle of the version series. Content Engine deletes the specified version and keeps the remaining original version numbers intact, thus leaving the version series with gaps in its numbering sequence. This applies to both single-level and two-level versioning scenarios.
Users or processes can delete a Major version or Minor version out of the middle of the version series. If the version being deleted is a Released Major version, Content Engine updates the status of the previous Major version, if one exists, to Released.
Deletes are allowed on Major versions and Minor versions, regardless of which version state they are in.
The following sequence table shows the effects of deleting a version from the middle of a version series. Red text denotes change from the row above:
Versioning actions | Versions created | ||||
---|---|---|---|---|---|
First version | Second version | Third version | Fourth version | ||
1 | Check in fourth version as Minor. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Superseded |
Version #: 2.0 Status: Released |
Version #: 2.1 Status: In Process Current version |
2 | Delete the third version. The version series consists of 0.1, 1.0, and 2.1. | Version #: 0.1 Status: Superseded |
Version #: 1.0 Status: Released |
Version #: 2.1 Status: In Process Current version |
See Delete a single document version for more information.
Freezing a version prevents changes to its otherwise modifiable custom properties. Only a specific version's custom properties are frozen. The system-maintained properties of a frozen document version can continue to be updated by the system as necessary.
Once a version is frozen, there is no way to unfreeze it. However, you can check out a frozen document to create new (unfrozen) versions. Frozen documents can also be promoted or demoted.
See Freeze a version for more information.