CLI Reference > Workflows and Documents Commands > im incrementrevision
 
im incrementrevision
increments the revision of an item
Synopsis
im incrementrevision [--force] [--major] [--minor] [--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 incrementrevision increments the revision number of an item.
Item revisions mark an unambiguous point in the history of an item. When viewing an item in Integrity Lifecycle Manager, the revision provides an identifier into its history. Furthermore, if you export the same item to a partner using a report or through ReqIF, and they call you to discuss it, you are assured that any discussion of Item 123, revision 1.2, for example, is done with the exact same item definition and understanding.
This is also true for everyone with direct access to Integrity Lifecycle Manager. When listing items, you have clear visibility to the item revision. As with the partner scenario, any internal communication through conversations, reports, or e-mail, can include a specific revision to ensure all parties are using the same exact definition.
The revision identifier is numbered as a two-part decimal in the format major.minor, where the number to the left of the decimal point is the major revision, and the number to the right of the decimal point is the minor revision. Your Integrity Lifecycle Manager administrator defines the revision pattern for revision numbers by specifying values in workflow and document properties. For example, the default revision number sequence is 0.1, 0.2, 0.3, ... 1.0, 1.1, 1.2. For information on your revision pattern for revision numbers, contact your administrator.
For example, consider the following item revisions:
Item 100 is at revision 1.5. There are no changes to the item since the last revision.
Item 200 is at revision 2.8. There are changes to the item since revision 2.8.
Specifying:
im incrementrevision --minor 100
does not increment the minor revision of the item. By default, the revision is incremented only if there have been changes since the last revision.
Specifying:
im incrementrevision --minor --force 100
increments the minor revision of item 100 to revision 1.6. The --force option overrides the default behavior and increments the revision, even though there have been no changes since the last revision.
Specifying:
im incrementrevision --major 200
increments the major revision of item 200 to revision 3.1.
Note the following:
If item labels are enabled for the item type, incrementing the revision number automatically adds a revision label (using the revision number) to the item. For example, if you increment the revision to 1.2 and item labels are enabled, Integrity Lifecycle Manager automatically creates a 1.2 revision label in the Labels tab. Revision labels display in ascending order by default. The label :head is a system provided label and always appears first in the list. The date and time of :head are updated by revision operations; thus, the date and time are always set to that of the latest item revision.
To control and automate item revisioning in your environment, your administrator may implement event triggers that automatically increment the revision of an item with workflow changes, such as the "Ready for Review" state.
When copying a revisioned item, the revision on the existing item is not copied to the new item.
There is no way to set an arbitrary revision. When an item is revisioned, the next available number defined by the revision schema sets the next revision.
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.
--force
forces the increment to occur even when the item is unchanged. By default, the revision is not incremented when the item is unchanged.
* 
When incrementing a revision, an item with no previous revision number is considered to contain changes. Therefore, if you do not specify the --force option, an initial revision number is created.
--major
increments the major revision number. For example, if the current revision is 1.5, incrementing the major revision updates the revision to 2.1.
--minor
increments the minor revision number. For example, if the current revision is 1.5, incrementing the minor revision updates the revision to 1.6. By default, the minor revision number is incremented.
issue id...
the ID of the item you are incrementing the revision for. Use spaces to specify more than one item.
See Also
Miscellaneous: ACL, diagnostics, options, preferences