si report
collates SCM data into text files for reporting by a third party utility
Synopsis
si report [--basename=value] [(-P project|--project=project)] [(-S sandbox|--sandbox=sandbox)] [ --devpath=path] [--projectRevision [--[no]failOnAmbiguousProject] =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]] [-F|--selectionFile=value] [--status=[none|gui|default]]
Description
The si report command collates SCM data into a series of text files that can then be accessed by a third party reporting tool. The third party tool is responsible for formatting the data in the text files into the desired reporting format.
|
|
This command is deprecated in Windchill RV&S; however, it can still be used with a third party reporting tool.
|
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.
• --basename=value
Specifies the name of generated tables.
si report uses the following suffixes to indicate the contents of the table:
.txp project information
.txm member information
.txa archive information
.txr revision information
.txs symbols
.txx access information
Data Fields
In the generated data files, the first line of each data file contains field names.
The fields for the project information file (.txp) are:
◦ ProjId
(integer) A unique identifier of a project (Primary Key)
◦ ProjName
(string) The project path/name
The fields for the member information file (.txm) are:
◦ ProjId
(integer) A unique identifier for the project, can be used as a key. Taken from project info (Foreign Key - 1:M).
◦ MemberName
(string) Member file path/name.
◦ MemberType
(string) Valid values are:
▪ a archive
other (only valid for projects imported from
▪ f older versions of Windchill RV&S (formerly MKS
Source or Source Windchill RV&S Standard)
▪ i sub-project
◦ Revision
(string) Revision number of member (can be NULL).
◦ ArchId
(integer) A unique identifier of the member file, may be an archive id or another project id (can be NULL). Can be used as a primary key.
The fields for the project information file (.txa) are:
◦ ArchId
(integer) A unique identifier of the member file, may be an archive id or another project id (can be NULL). Can be used as a primary key.
◦ ArchiveName
(string) File path/name, only for archives.
◦ Head
(string) Revision number of the head revision.
◦ Branch
(string) Branch number of a default branch if one has been set by si archiveinfo –b. (can be NULL).
◦ NumLocks
(integer) The number of locked revisions.
◦ Format
(string) One of text, binary or auto-detect.
◦ Encrypted
(integer) Set to 1 if the archive is encrypted. This option is not supported in Windchill RV&S.
◦ TotalRevs
(integer) Total number of revisions in the archive.
◦ Branches
(integer) Total number of branches in the archive.
◦ BranchRevs
(integer) Total number of revisions on branches.
◦ Comment
(string) Comment delimiter if set (can be NULL). This field is historical.
◦ Description
(string) Text describing an archive. This text is entered when the archive is first created.
The fields for the revision information file (.txr) are:
◦ ArchId
(integer) A unique identifier of the member file, may be an archive id or another project id (can be NULL). Can be used as a primary key.
◦ RevNum
(string) The revision number of this revision (unique per ArchId).
◦ Date
(string) The date this revision was entered, in the format yyyy/mm/dd hh:mm:ss.
◦ Author
(string) The author’s name (usually the author’s user ID).
◦ State
(string) The state assigned to this revision; this is taken from state list items).
◦ LinesAdded
(integer) The number of lines added by this revision; derived from delta information.
◦ LinesDeleted
(integer) The number of lines deleted by this revision.
◦ Locker
(string) The name of the user holding a lock on this revision (usually the user’s user ID) and the time when the revision was locked.
◦ LogMsg
(string) Text description of the changes made by this revision as entered at check in.
The fields for the symbol information file (.txs) are:
◦ ArchId
(integer) A unique identifier of the member file, may be an archive id or another project id (can be NULL). Can be used as a primary key.
◦ RevNum
(string) The revision number of a revision that has an associated symbolic label. The revision number may not be unique in a list.
◦ Symbol
(string) The symbolic label.
The fields for the access information file (.txx) are:
◦ ArchId
(integer) A unique identifier of the member file, may be an archive id or another project id (can be NULL). Can be used as a primary key.
◦ UserId
(string) Name (user ID) of user who is included in an access list (Source Windchill RV&S Standard only) for an archive. The archive and project ID numbers (ArchId and ProjId) are unique for any set of reports (though they may change from one use of report to another). They may be used as keys.
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
