Help about Bugs & ideas

[Main Help Page]

[Help Index]

READ THIS FIRST! — If you have noticed that some of the data is out of date - you want to add a bridge or a marina for example - you can do this yourself. Simply log in, visit the nearest existing place to the new one in the gazetteer and use the "edit" feature in the menu. If you have problems, report what you have done as a new issue Here; someone will help you and it will make me aware of where the instructions aren't good enough.
Similarly if the dimensions of a waterway - the headroom, length, width or depth are wrong or missing you can do this yourself. Visit the waterway in the gazetteer and use the "edit" feature in the menu.

Reporting bugs — If you have found an actual bug: a miscalculation, something that doesn't work as you'd expect, or there's something you'd like to do that the program doesn't seem to allow you do, please report it as a bug or request for improvement.
Before July 2015 we have been using Google's "code" to track bugs. This is being withdrawn and will shortly become read-only. Until we have transferred outstanding items, and the history of fixed bugs, it's available for reference here.
CanalPlanAC now has its own bug-tracking system using a free package called mantis. With some nifty coding we've been able to make it so that you don't need a separate account: as long as you are logged into CanalPlan you can report a bug or request a new feature.
If you aren't logged on, I recommend you do so now using one of the two links in the menu sidebar.

Bug Tracker — The main page is split into three parts. Menu, Search Criteria, List of Issues.

View Issues — Views all the issues that have been logged since the Mantis Bug Recording System was introduced.
Report Issue — Menu option to report an issue.
Change Log — Menu option which shows the changes made to each version of CanalPlan
Roadmap — Menu option which shows the percentage completion of changes made to each version of CanalPlan
My Account — Menu option which shows your CanalPlan account details which can be edited (see below).
Logout — Menu option to logout.

Search Criteria

A full search facility is available as there are 28 different criteria that can be applied to the list of issues. Click on the underlined text and a drop-down selection list will appear. When all the criteria have been selected either click on Apply Filters; or Reset Filters to return to full view.

List of Issues

A list of all the issues that have been logged. They can be sorted by Priority, ID No, Category, Severity, Status, Updated, or Summary by clicking on the column title. Click Reset Filters to return to issue number order.

View — To view an issue click the issue number. This view will show the following:

who reported the issue
who the issue is assigned to
its priority
its severity
its reproducibility
its status
is the issue resolved
summary of the issue
description of the issue
any attached files
a list of notes added which show the history of the issue

Add a comment to an issue — Select an issue and scroll down to Add Note. Add any new information or comments and click on Add Note.
Report an issue — Select Report Issue

Enter Report Details — There are a number of fields to fill in, the mandatory fields are starred.

Category* — Default (select), select the category which best fits the issue.

Route Planning
[All Projects] Bug
[All Projects] Data Maintenance
[All Projects] Database
[All Projects] Feature Request
[All Projects] General
[All Projects] Internal Improvements — Technical use only
[All Projects] Server Configuration — Technical use only

Reproducibility — Default (have not tried), select how reproducible the issue is.

always
sometimes
random
unable to reproduce
N/A

Severity — Default (minor), select how severe the issue is.

minor
feature
trivial
text
tweak
major
crash
block

Priority — Default (normal), select how high a priority it is to fix the issue.

none
low
high
urgent
immediate

Select Profile — Default (Generic N/A N/A), select the profile of the computer you are using, or fill in the details below. To save time your profile can be pre-prepared in My Account
Platform — Type of computer.
OS — Operating system used.
OS Version — Operating system version.
Product Version — Version of CanalPlan you are using (hover mouse over CanalPlan Logo).
Product Build — Build Number of CanalPlan you are using (hover mouse over CanalPlan Logo).
Summary* — Provide a summary of the issue or feature
Description* — Provide a detailed description of the issue or feature. Add as much description possible so that it can be replicated and fixed.
Steps To Reproduce — Provide the steps required to reproduce the issue or feature. Try to put one step per line to aid replication.
Additional Information —Add any additional information to fix or add the feature.
Upload File (Maximum size: 5,000k) — Files or pictures can be uploaded by clicking on Browse and selecting a file from your computer. Please select and upload one file at a time.
View Status — Default (Public), click public or private
Report Stay — Default (none), check tick box if you have another issue/feature to report.

When finished click Submit Report to save settings. Click Back Button or one of the menu options to Discard as appropriate.

My Account

Edit Account

Username — This shows your Internal Canaplan ID.
Password —. Default (existing password), you can change your password here
Confirm Password — Default (existing password), confirm if you have changed your password.
E-mail — Default (existing email address), you can change your email address here
Real Name — Default (existing name), you can change your name here
Access Level — Defined by CanalPlan
Project Access Level — Defined by CanalPlan, non-editable.
Assigned Projects — Defined by CanalPlan, non-editable.

When finished click Update User to save settings. Click Back Button or one of the menu options to discard as appropriate.

Preferences

Account Preferences — There are 14 preferences that can be changed. Most are about sending an email to you if an event happens with any of the issues. The Time Zone can be changed to reflect your geographical position and Language to your preferred language.

When finished click Update Prefs to save settings or click Reset Prefs to discard as appropriate.

Manage Columns —

All Available Columns — The available columns for viewing and reports are shown.
View Issues Columns* — Columns from All Available Columns can be added to this section or deleted to personalise the views.
Print Issues Columns* —. Columns from All Available Columns can be added to this section or deleted to personalise Print Reports in the View Issues section.
CSV Columns* — Columns from All Available Columns can be added to this section or deleted to personalise CSV Export in the View Issues section.
Excel Columns* — Columns from All Available Columns can be added to this section or deleted to personalise Excel Export in the View Issues section.

Report/Views marked with * are required.

When finished click Update Columns For Current Project to save settings. Click Back Button or Reset Columns Configuration to discard as appropriate.

Profiles —

Add Profile — This option allows the setting up of a profile of the computer used to access CanalPlan.

Platform — Type of computer.
OS — Operating system used.
OS Version — Operating system version.
Additional Description — Any additional information ie browser used.

Items marked with * are required.

When finished click Add Profile to save settings. Click Back Button or one of the menu options to Discard as appropriate.

Edit or Delete Profiles

Select either Edit Profile, Make Default or Delete Profile
Select Profile — Select one of the profiles created. When finished click Submit to save settings. Click Back Button or one of the menu options to Discard as appropriate.

[Main Help Page]

[Help Index]