Overview
Change Viewers are used to link from changes displayed in pulse™ to an external changelist viewer such as Fisheye
. This allows integration of pulse™ with other systems, allowing easy browsing of change information. Viewers can link to some or all of the following:
- Changelist views: the changelist number/identifier in pulse™ is linked to the change view in the external viewer
- File views: changed files have links to the file view at the corresponding revision
- File downloads: changed files have links to the download the raw file at the corresponding revision
- File diffs: changed files have links to the file diff view for the corresponding change
Currently, there is built-in support for Fisheye, P4Web, Trac and ViewVC. You can also configure a custom viewer if your external tool is not directly supported.
Configuring Change Viewers
You can configure the change viewer for a project by clicking the "edit" link in the top right corner of the "change viewer" table on the project's "configuration" tab. This will take you in to the Change Viewer Wizard. The first step of the wizard prompts you to select the change viewer type. Each type is described in the subsections below.
Custom Viewers
A custom change viewer is used to link to a system that is not directly supported by pulse™. To configure a custom viewer, you can supply the URLs for the features your external tool supports, and leave any unsupported links blank. When configuring the URLs, various properties are made available (refernced via ${<property name>}), allowing you to reference details of the file and/or revision being linked from. For the changelist URL, the following properties are available:
| Variable |
Description |
Availability |
Example |
| author |
The author of the change (SCM username). |
All SCMs |
jdev |
| branch |
The branch the change was committed on. |
CVS only |
1_0 |
| revision |
The revision number or identifier. |
All SCMs |
100 |
| time.fisheye |
The timestamp of the change in the format yyyyMMddHHmmss. |
All SCMs |
20060707030412 |
| time.pulse |
The timestamp of the change in the format yyyyMMdd-HH:mm:ss |
All SCMs |
20060707-03:04:12 |
For the file URLs, the following properties are available:
| Variable |
Description |
Availability |
Example |
| path |
The path of the file, encoded suitably for use in a URL path. |
All SCMs |
/path/to/file%20with%20spaces |
| path.form |
The path of the file, encoded suitably for use as a GET parameter. |
All SCMs |
%3Fpath%3Fto%3Ffile+with+spaces |
| path.raw |
The path of the file, with no encoding applied. |
All SCMs |
/path/to/file with spaces |
| previous.revision |
The previous revision of the file, if any. |
All SCMS |
2 |
| revision |
The revision of the file. |
All SCMS |
3 |
Examples
Link Subversion changes to a project named "svn" in a Fisheye installed on fisheye.example.com:
A file diff URL for an imaginary tool:
Fisheye Viewers
Used to link to an external Fisheye instance. To configure a Fisheye viewer, specify the URL for your Fisheye server, and the name the repository within Fisheye.
P4Web Viewers
Used to link to an external P4Web instance. To configure a P4Web viewer, specify the URL for you P4Web server.
Trac Viewers
Used to link to an external Trac instance. To configure a Trac viewer, specify the URL of your Trac server.
ViewVC Viewers
Used to link to an external ViewVC (formerly ViewCVS) instance. To configure a ViewVC viewer, specify the URL of your ViewVC server, and the path of the project within the server (e.g. project/trunk).
