si viewsandbox

CLI Reference > Configuration Management Commands > si viewsandbox

si viewsandbox

displays the contents of a Sandbox

Synopsis

si viewsandbox [--[no]includeDropped] [--fields=field1[:width1],field2[:width2]...] [--[no]filterSubs] [--height=value] [--width=value] [-x value] [-y value] [(-R |--[no|confirm]recurse)] [--filter=filteroptions] [--[no]failOnAmbiguousProject] [(-S sandbox|--sandbox=sandbox)] [--lockRecordFormat=value] [--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)] [--[no]persist] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] current or dropped member/subproject...

Description

si viewsandbox displays the contents of a Sandbox, for example:

c:\Documentation\xml_man\si_about.1.xml archived 1.6
c:\Documentation\Man_Pages\xml_man\si_acv.1.xml archived 1.7
c:\Documentation\Man_Pages\xml_man\si_add.1.xml archived 1.7 sueq Jun 21, 2009 - 10:14 AM
Working file 2,739 bytes smaller, older (Jun 20, 2009 - 1:46:27 PM)
c:\Documentation\Man_Pages\xml_man\si_addlabel.1.xml archived 1.6 sueq Jun 21, 2009 - 10:14 AM
Working file 7,344 bytes smaller, older (Jun 20, 2009 - 2:49:28 PM)
c:\Documentation\Man_Pages\xml_man\si_addmemberattr.1.xml archived 1.4 sueq Jun 21, 2009 - 10:14 AM
Working file 5,795 bytes smaller, older (Jun 20, 2009 - 3:16:29 PM)
c:\Documentation\Man_Pages\xml_man\si_addprojectattr.1.xml archived 1.4
c:\Documentation\Man_Pages\xml_man\si_addprojectlabel.1.xml archived 1.4
c:\Documentation\Man_Pages\xml_man\si_appendrevdesc.1.xml archived 1.6
c:\Documentation\Man_Pages\xml_man\si_archiveinfo.1.xml archived 1.5

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.

• --[no]includeDropped

controls whether to include members dropped from the project that still have working files in your Sandbox. Dropped members will be marked as dropped.

• --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 options. Under the CLI the fields are separated with a space>.

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

◦ deferredOperationInformation

returns true if a member has a deferred update revision associated with it.

◦ archiveshared

displays indicators for members that share another member’s archive. This column is valid only if you are using the database repository.

◦ attributes

displays member and project attributes.

◦ changedsincelastcheckpoint

displays members that have changed since the project was last checkpointed. This field displays members changed due to operations that caused a change in member revision. These operations include Add Member, Rename Member, Move Member, Update Member Revision, and so on.

◦ context

When used with the Windchill RV&S API, displays the name of the project, and indicates if the project is a build or variant.

This field is not valid for use with the CLI.

◦ cpid

displays the change package associated with the operation that set the member revision.

◦ creationcpid

displays the change package that created the revision that is currently the member revision. This revision may be different from the Member CPID if an import, add member from archive, or set member revision operation was used.

◦ deferred

displays all deferred operations.

◦ frozen

displays indicators for frozen members.

◦ indent

indents a field. For example:

si viewsandbox --fields=indent, name, type, memberrev

indents the name field, followed by type and memberrev fields, indenting as you recurse into subprojects.

This field is not valid for use with the Windchill RV&S API.

◦ labels

displays labels assigned to the member revision. Also displays checkpoint labels on a subproject configured as build. Multiple labels on the same checkpoint are displayed as a comma-separated list.

◦ lockrecord

a comma separated list of locks on the member. The locker and lock type are displayed by default for each lock. You can customize the lock information that displays by using the --lockRecordFormat option.

◦ memberarchive

display the name of the archive to which the member refers.

◦ memberdescription

displays the revision description assigned to the Sandbox member.

◦ memberrev

displays the member revision.

◦ membertimestamp

displays the date and time the member revision is set.

◦ merge

displays any merge information between member revisions.

◦ name

displays the member name.

◦ newrevdelta

displays indicators for new revisions.

◦ pendingcpid

displays the change package associated with a pending operation.

◦ revsyncdelta

displays an indicator for out of sync members.

◦ state

displays the member state.

◦ symboliclink

specifies whether the member is a symbolic link file member.

◦ type

displays the type of each item in the Sandbox: Sandbox, sub Sandbox, or member.

◦ wfdelta

displays an indicator when the working file is different from the member revision.

◦ workingarchive

displays the name of the archive from which the working file is derived.

◦ workingcpid

displays the change package associated with a deferred or a lock operation performed by the current user from the current Sandbox.

◦ workingrev

displays the working file revision.

• --[no]filterSubs

controls whether to display sub Sandboxes and directories that do not contain members matching the current filter.

• --[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.

• --lockRecordFormat=value

defines the format for displaying lock information in the --lockrecord field. 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 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.

• current or dropped member/subproject...

identifies a specific member or subproject that currently exists in the project, or one that has been dropped from the project. Use spaces to specify more than one.

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.