Hi Kristis,
Sorry for the delay - eventually got round to put together some text for
the
manual.
File attached - and also added to bug 1118
Thanks
Rob
7.4 ScmBug - WebReports Documentation
There are several Web hosted reports that are available in ScmBug.
To enable these reports a Web server is required. A configuration file
for apache is provided in the etc\scmbug directory, add the following line
to your apache.cof file to pick it up:
Include "C:/Program Files/Scmbug/etc/scmbug/apache.conf"
7.4.1 Web Report Configuration
The configuration for the web reports are in WebReports.conf and have the
following values:
# Port and location the daemon will start on
daemon_port => "3872",
daemon_location => "localhost",
This is so that the Web Reports code can make calls to the ScmBug server,
the default values will match the ScmBug defaults.
temp_dir => "C:/Temp",
This is the temporary directory that is used for staging data during the
generation of various web reports
# Webpage display settings
heading_banner => "/scmbug/images/dot_clear.gif",
This enables the customization of the web reports with a custom banner.
bug_tracker_url => "",
The optional URL of a bug tracker so that links can be generated on any
appropriate web reports web page.
# Codestriker Topic support (Leave blank if not required)
# Enter the URL (e.g. http://localhost/codestriker/codestriker.pl)
# and the directory that holds the CodestrikerClient.pm file
codestriker_url => "",
codestriker_client_path => "",
Optional values for integration with the codestriker project.
# List of repositories
repositories => [
{
name => "Code Repository",
repository_url =>
"http://localhost/svn/coderepo/";,
viewvc => "http://localhost/viewvc/CodeRepo/";,
websvn =>
"http://localhost/websvn/wsvn/CodeRepo/";,
bugid_regex => 'bug\s*([\d|\s|,|#]*?):',
bugid_split_regex => ',\s?#|\s?#|,|\s',
# If the first list of directories of the
repository should
# be listed as a multi-select (y/n)
autoproject_list => 'n'
}
],
The list of repositories which web reports can run on.
name - The display name for the repository
repository_url - URL of the repository
viewvc - (Optional) URL to ViewVC
websvn - (Optional) URL to WebSVN (MultiView enabled)
bugid_regex - Regular Expression for bug IDs
autoproject_list- Enable/disable dynamic root directory generation
# Link to the next page after the bug report this allows custom
# release documents to be created. This link should be a perl cgi
# script so that it can recieve the list of bug IDs
bug_report_next_page => "/scmbug-cgi/bug_report_input_form.pl",
The (Optional) page to display after the initial bug report so that custom data
can be requested to generate an Impact document. The default is a generic page
that can be customised to suit each users needs.
# The following values are used by the example second page on the bug
report
# it shows how values can be set and loaded into the report
report_form_data => {
OSs => [ 'Windows Server 2003', 'Windows XP', 'Linux' ],
versions => [ 'N/A', '1.0', '2.0' ],
stages => [ 'N/A', 'Alpha1', 'RC1', 'GA' ],
dbtypes => [ 'Oracle', 'SQL', 'DB2' ],
managers => [ 'John Smith', 'Jane Doe' ],
# The following argument allows the addition of a hand crafted
# update page at the end of the Impact document generation
final_update_page => ""
},
The data used to display the form to generate the impact document.
The final_update_page value enables the user to specify an additional
URL that can then be used to perform additional operations such as
update bug tracking systems.
# Set the default E-mail parameters
email_config => {
smtp => 'smtp.tibco.com',
email_from => '[email protected]',
email_domain => '@tibco.com'
},
E-mail settings to use when sending out E-mail notifications.
7.4.2 Affected Files Report
This report will retrieve all of the affected files for a given bug
(or list of bugs - comma seperated) and group the file list under changes
for each file. A link to ViewVC or WebSVN can be created for each.
The initial page location is:
http://localhost/scmbug-cgi/affected_files.pl?run_report=N
7.4.3 Bug Report/Impact Document
This report will retrieve all of the bugs that have been used to change
code between the two specified revisions (inclusive).
NOTE: At the moment this is only implemented for SUbversion repositories
The initial page location is:
http://localhost/scmbug-cgi/bug_report.pl?run_report=N
The intension of this report is to generate an "Impact Document"
(or Release Document) for a given repository.
Page 1:
Enter the Start and end revisions along with the repository path
that the release is from.
Page 2:
This will then generate a report of all the Bugs that have toughed
code between the two revisions. It will display the status of each bug,
who it is allocated to and the summary description line. If the
codestriker
integration is enabled it will also display links to any reviews
carried out
for a given bug. Open bugs will be highlighted in red, if there are
any
open then an "E-mail Open Assignees" button will be displayed.
Selecting "E-mail Open Assignees" will generate another page that allows
the users to be E-mailed with a customisable message.
Once happy with the status of all bugs then the next button can be
clicked.
Page 3:
The next page that is displayed will be the template for entering data
required in a given Impact document - this page is the one specified
in the WebReports.conf under the bug_report_next_page variable. It
can be customised by the user to suit their needs. By entering an
E-mail address at this point and clicking on "Generate Impact Document"
the completed impact document will then be E-mailed to the user.
Page 4:
This page will display the completed Impact Document - the same as the
copy that was (optionally) E-mailed. This page may also contain a
button
to "Update Fault Tracker" if the final_update_page value in the
configuration
was wet.
_______________________________________________
scmbug-users mailing list
[email protected]
http://lists.mkgnu.net/cgi-bin/mailman/listinfo/scmbug-users
