si locate
displays where a project, subproject, member, or revision is used
Synopsis
si locate [--depth=[current|build|all]] [--devpathscope=[this|others|all]] [--[no]failOnAmbiguousProject] [--distinct=[project|devpath|registeredproject]] [--[no]exactmatch] [--[no]casesensitive] [--[no]limittoactivepaths] [--listfields=field1[:width1],field2[:width2]...] [--mode=[distinct|list]] [--numberofresults=value]] [--memberbyname=value]] [--subprojectbyname=value]] [--projectscope=[this|others|all]] [(-r value|--revision=value)] [--height=value] [--width=value] [-x=value] [-y=value] [(-P project|--project=project)] [(-S sandbox|--sandbox=sandbox)] [--devpath=path] [--projectRevision=rev] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] member/subproject
Description
As projects grow in complexity, it can be difficult to determine the relationships that Windchill RV&S configuration management objects--projects, subprojects, and members--have with one another. When working with multiple development paths and shared subprojects or shared member archives, it becomes very important to understand what areas of a project might be affected by parallel development. Using the si locate command, you can locate where a specific Windchill RV&S object is used in your source code repository and refine and sort the search results.
For example, you might need to:
• Determine what active projects (a project currently under development) a member, subproject, or registered top-level project is shared into.
• Determine what development paths a selected member or subproject is a part of.
• Determine if a selected member revision is part of a checkpoint.
• Confirm all existing checkpoints for a selected revision before you delete it.
• Display the development path that a corresponding member revision belongs to.
• Display which master projects a selected subproject belongs to.
Windchill RV&S displays the search results in one of the following modes:
• Distinct Mode provides a high-level view of the information.
• List Mode provides a detailed view of the information.
Key Considerations:
• You require the OpenProject permission for the project you are running the si locate command from. When the Locate view displays, Windchill RV&S informs you if there are additional projects that you do not have permission to view.
• Archive locations are not displayed in the search results.
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.
• --depth=[current|build|all]
specifies the depth of the search. --depth=current searches current project configurations (normal and variant).--depth=build searches current project configurations and checkpoints.--depth=all searches current project configurations, checkpoints, and in between checkpoints.
• --devpathscope=[this|others|all]
specifies which development paths to include in the search. --devpathscope=this searches the current development path. --devpathscope=others searches all development paths, except the current development path. --devpathscope=all searches all development paths.
• --distinct=[project|devpath|registeredproject]
specifies the information you want displayed in Distinct Mode. This option must be used with --mode=distinct. --distinct=project lists only distinct project names.--distinct=devpath lists only development path names.--distinct=registeredproject lists only registered top-level project names.
• --[no]exactmatch
when searching by name, specifies whether to match the name exactly. This option can only be used in conjunction with the --memberbyname or --subprojectbyname options.
• --[no]casesensitive
when searching by name, specifies whether to match the case of the name. This option can only be used in conjunction with the --memberbyname or --subprojectbyname options and with case insensitive databases.
• --[no]limittoactivepaths
specifies whether to search projects referenced by current registered top level projects on the server.
• --listfields=field1[:width1],field2[:width2]...
allows you to select fields to be displayed when you use the --mode=list option, specified in the format field1[:width1],field2[:width2].... Specifying the column [: width] (in pixels) for each field is optional (widths are only available in the GUI). In the CLI, fields are separated with a space. This option must be used with --mode=list.
You can display one or more of the following fields:
◦ checkpoints
displays the checkpoints that the object belongs to.
◦ checkpointlabels
displays parent project's checkpoint labels. Multiple labels on the same checkpoint are displayed in a comma-separated list.
◦ configPath
displays the configuration path for the object.
◦ dates
displays the date ranges in which the object exists.
◦ devpath
displays the development paths that the object belongs to.
◦ flatPath
displays the flat path for the object.
◦ name
displays the object's path and name.
◦ project
displays the projects that the object belongs to.
◦ revisions
displays the member's revisions.
◦ registeredproject
displays the top-level projects that the object belongs to.
• --mode=[distinct|list]
specifies the level of detail to display in the search results. --mode=distinct displays only the projects and/or development paths that contain the object you are searching. This option must be used with --distinct=[project|devpath|registeredproject]. --mode=list displays all occurrences of the object in the projects and/or development paths that contain the object. If you do not specify a mode, --mode=distinct and --distinct=devpath are used.
• --memberbyname=value
specifies the name of the member to search for. The name you enter can contain the * and ? wildcard characters. For Linux, the name you enter can contain the \ escape character.
• --subprojectbyname=value
specifies the name of the subproject to search for. The name you enter can contain the * and ? wildcard characters. For Linux, the name you enter can contain the \ escape character.
• --numberofresults=value
when searching by name, specifies the maximum number of results to return. This option can only be used in conjunction with the --memberbyname or --subprojectbyname options.
• --projectscope=[this|others|all]
specifies which projects to search. --projectscope=this searches the specified project.--projectscope=others searches all projects and subprojects, except the current project.--projectscope=all searches all projects and subprojects.
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.
See Also