si viewhistory

CLI Reference > Configuration Management Commands > si viewhistory

si viewhistory

displays a member's history

Synopsis

si viewhistory [--fields=field1[:width1],field2[:width2]...] [--height=value] [--width=value] [-x value] [-y value] [--filter=filteroptions] [--rfilter=filteroptions][(-P project|--project=project)] [(-S sandbox|--sandbox=sandbox)] [--[no]failOnAmbiguousProject] [--lockRecordFormat=value] [--lockRecordDetailFormat=value] [--maxTrunkRevs=value] [--checkpointLabelFilter=value] [--devpath=path] [--projectRevision=rev] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--maxTrunkRevs=value] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--[no]persist] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] member...

Description

si viewhistory displays a member's history, one line per revision, per member. This is similar to si print and si rlog, but with different defaults.

While Sandboxes and projects allow you to manage and access project members and the contents of individual members, the history of changes are saved in member histories.

Windchill RV&S lets you save and recreate every stage (or revision) in the development of each member you use. When you make changes to a project member and check it back in, your changes are automatically added to the member history.

Options

This command takes the universal options available to all si commands, as well as some general options. See the options reference page for descriptions.

• --fields=field1[:width1],field2[:width2]...

allows you to select fields to be printed, specified in the format field1[:width1],field2[:width2].... Specifying the column [:width] (in pixels) for each field is optional - widths are only available with the -g or --gui options. Under the CLI the fields are separated with a space.

The fields available for printing can be one or more of the following:

◦ author

displays author names.

◦ checkpointlabels

displays labels of checkpoints in which the member revision participated. This field is not displayed by default. Can be used with --checkpointLabelFilter to filter the checkpoint labels displayed.

◦ cpid

displays the associated change package identifier (applies only if change packages are enabled).

◦ date

displays the revision date.

◦ description

displays revision descriptions.

◦ labels

displays labels.

◦ lockrecord

a comma separated list of locks on the revision. The locker and lock type are displayed by default for each lock. You can customize the lock information that displays in the List Member History view in the GUI by using the --lockRecordFormat option. You can customize the lock information that displays in the Details panel of the Graphical Member History view in the GUI by using --lockRecordDetailFormat option.

◦ state

displays the state.

• --[no]persist

controls whether this presentation of information should continue to be updated as new information becomes available. --nopersist forces a static "snapshot" of information, while --persist gives real-time updates.

• --rfilter=filteroptions

allows you to display any revisions of the current member that meet the selection criteria specified in the filteroptions. Comma separated expressions are combined using an OR operator. Multiple occurrences of an option are combined using an AND operator. A leading ! negates any simple filter that follows. For example,

--rfilter=labeled:Release 3.0,branchboundaries --rfilter=!labeled:obsolete

displays all revisions with a label of "Release 3.0" or at a branch boundary and whose label is not "Obsolete". The filteroptions can be one or more of the following:

• range:low-high

selects revisions that are in the specified revision number range. If required, you can specify just one end of the range. The range includes the low and high values. To specify multiple ranges, the range keyword must be repeated, for example --rfilter=range:1.100-1.200,range:1:400-1:500

• branchrange:low-high

selects branched revisions that are in the specified revision number range. If required, you can specify just one end of the range. The range includes the low and high values. To specify multiple ranges, the branchrange keyword must be repeated, for example --rfilter=branchrange:1.2.1.1-1.2.1.5,branchrange:1.4.1.1-1.4.1.5

• daterange:<date>-<date>|:past:<nb>:syears|months|days|hour

selects revisions that were created during a specified time range or during a specified amount of time in the past. <date> specifies a date in any of the local date/time formats. For more information on date/time formats, see the options reference page. <nb> is used to specify the number of units to include in the range for a specified amount of time in the past.

If the date/time format contains either "-" or "," you must quote each date. For example: --rfilter=daterange:"June 21, 2009 - 6:07:28 PM"-"June 25, 2009 - 6:07:28 PM"

When in a shell, you must use two kinds of quotes so that the shell does not remove them. For example: --rfilter=daterange:'"June 21, 2009 - 6:07:28 PM"'-'"June 27, 2005 - 6:07:28 PM"' or--rfilter=daterange:"'June 21, 2009 - 6:07:28 PM'"-"'June 25, 2009 - 6:07:28 PM'"

• branch[::current|:name]

selects revisions that are on the specified branch.

• labeled:name

selects revisions with labels. If a label name is specified, only revisions with that label are displayed. If no label name is specified, all labeled revisions are displayed.

• labellike:pattern

selects revisions that match the specified pattern. Your administrator determines whether glob or regex patterns are used for matching.

• locked[::me|::anyone|userName]

selects revisions that are locked. If me or a user name is specified, only revisions locked by that user are displayed. If no user or anyone is specified, all locked revisions are displayed.

• locktype[:exclusive|:nonexclusive|:any]

selects revisions that are locked with the specified lock type. If no lock type or any is specified, all locked revisions are displayed.

• state:name

selects revisions that are at the specified state.

• author[::me|:userName]

selects revisions created by the specified author.

• pending

selects revisions that are pending.

• anyspecial

selects working and member revisions.

• branchboundaries

selects revisions that are branched, or at the base or tip of a branch.

--lockRecordFormat=value

defines the format for displaying lock information in the --lockrecord field of the List Member History view in the GUI. Specify a format string using keywords to represent the information you want to display. You can specify any of the following keywords:

• {revision}

displays the revision that is locked.

• {locker}

displays the user who locked the revision.

• {locktype}

displays the type of lock on the revision (exclusive or non-exclusive).

• {locktimestamp}

displays the time when the revision was locked.

• {lockcpid}

displays the change package associated with the lock on the revision.

• {project}

displays the name and path of the project where the member revision was locked from. If the member revision was locked from a shared subproject, it is the subproject name and path that are displayed.

• {devpath}

displays the name of the development path where the lock on the revision was made from.

• {sandbox}

displays the name of the Sandbox where the lock on the revision was made. This is relevant when viewing the information from the locker host.

• {hostname}

displays the hostname of the computer that locked the the revision.

• {hascpid}

displays 1 if the lock has a change package associated with it, 0 if there is no associated change package.

• {hassandbox}

displays 1 if there is Sandbox information available for the lock, 0 if no Sandbox information is available.

• {hasdevpath}

displays 1 if the lock was made from a development path, 0 if it wasn't.

• {member}

displays the name of the locked revision.

--lockRecordDetailFormat=value

defines the format for displaying lock information in the --lockrecord field of the Graphical Member History view. Specify a format string using keywords to represent the information you want to display. See the --lockRecordFormat option for a list of keywords.

--maxTrunkRevs=value

specifies the maximum number of revisions to display. If you limit the number of revisions to be displayed, and the maximum is reached, a trailing message displays at the bottom of the list. The maximum number of revisions is based on the number of visible mainline revisions; branched revisions are not included in the count.

--checkpointLabelFilter=value

specifies a regular expression used to filter the checkpoint labels displayed for the member revisions. Used with --fields=checkpointlabels, for example:

si viewhistory --checkpointLabelFilter=IS_.* --fields=revision,author,date,checkpointlabels Console.java

member...

identifies a specific member; use spaces to specify more than one member.

Diagnostics

See the diagnostics reference page for possible exit status values.

Preferences

Using si setprefs or si viewprefs, you are able to set or view the preference keys for this command.