Root > Solving bugs in your code > Managing bug reports in issue tracker > Bug trackers setup > Redmine setup

Redmine setup

Previous pageReturn to chapter overviewNext page   

This article is part of Managing bug report in issue tracker series.


See managing bug reports in issue tracker for common information. Please, read it first. For common information and setup of Redmine itself - please see this article. The text below assumes that you already completed Redmine installation.


Below are detailed steps for recommended Redmine setup for automatic bug report submission. Before going through setup - make sure to upgrade your Redmine to the latest version.


Some steps below are optional, some steps must be executed only once (like custom fields creation), other are executed from time to time (like creating new projects for your new products) and the rest are executed regularly (like creating product versions).


Full list of necessary actions contains:

1. Creating custom fields (single act)
2. Creating user accounts (single act or per product)
3. Creating projects and setting it up (single act or per product)
4. EurekaLog setup (per product)
5. Testing (as required)
6. Maintaining project (regularly or from time to time)


Please note that all actions below are just examples. It's recommendation, but it's not necessary to be absolutely like that. You may use another configuration.


Note: You can use Redmine as external bug tracker for GitLab.



Creating custom fields

1. (Administration/Custom Fields) Create custom field (for issues) to improve usefulness of EurekaLog. Most important field is "Count" - to store number of sent/occurred problems. Its type should be "Number" (integer); field name can be arbitrary, like "Occurrences", "Bug count", "Popularity", "Incidents", "Hit Count", etc. Other suggested custom fields are: "BugID" (to store BugID and search issues), "e-mail" ("user e-mail", which is typically entered in MS Classic error dialog), and "version" (version of crashed module). All three fields should be text fields. Again, field names can be anything.



Make sure to check "Used as a filter" option when creating "BugID" field!
Use "Text" type for "Version" field. Do not use "Version" type for "Version" field. Redmine API has bug preventing supplying "Version"-type fields.


We strongly recommend to create at least "Count" and "BugID" fields.



Recommended setup for "BugID" field



Recommended setup for "Count" field



Recommended setup for "EMail" and "Version" fields



All four fields created


2. Create any other additional fields as you need/like (you can submit values for custom fields at run-time via OnCustomWebFieldsRequest event).



Creating user accounts

1. (Administration/Users) Create new user account for bug report submission. Create it with disabled e-mail notification:



Creating new user


Important: unfortunately, Redmine does not allow regular users to obtain list of users and custom fields. Therefore, you have to create administrator user if you want to use custom fields.


2. Repeat this step for each bug submitter user account which you want to create.


3. (Optional) You can also create a new group and/or role and include all bug-reporting user accounts into that group (Administration/Groups and Administration/Roles):



Creating new user group for bug reporting



Creating new role for bug reporting


4. (Optional) Open bug reporting user account and include it into a bug reporting group:



Associating user with group


Repeat this for all bug reporting accounts.



Creating projects

1. (Administration/Projects) Create project for your software product. You may create several projects - one for each of your software products.



Creating new project for bug reports


Make sure to include created custom fields.


2. Add users or groups to the project. Start project editing, go to "Members", click "New member". Select either specific user account, or group. You can also add a role.



Adding users and / or groups to the project


3. (Optional) Create categories for the projects. Typically category is used for identification of the part or aspect of your software product. Start project editing, go to "Issue categores", click "New category".



Creating category for the project


4. Create versions for the project. If you don't use versioning (highly unrecommended) - you can skip this step.


Version strings can be arbitrary like "1", "1.0", "1.0.1", "" or even " beta 3". However, it's recommended to use four-number versions with optional textual description, for example: "" and " beta 3".


For example:





When reporting - version are taken from file's version information, so you must supply the corresponding version in description of your .exe or .dll files.


Note: EurekaLog will use closest match. It will also look only for "released" ("open") versions.


Important: EurekaLog will look only for "Open" versions. Be sure to mark version of your .exe as "Open".



Enabling external access to bug tracker

1. (Administration/Settings/API) Enable access to bug tracker via API calls:



Enable "Enable REST web service" option



EurekaLog setup

1. Enter Redmine details into EurekaLog settings of your projects:



Redmine settings filled into EurekaLog options


Note: your login / password pair will be replaced with API key once you click "Connect" button. You can remove API key and re-enter login / password pair.


2. Set any additional/common send options.


3. Set/fill custom fields. EurekaLog has support for automatic managing of "Count", "BugID", "E-Mail", and "Version" fields. You just need to enter field names in EurekaLog options. For other custom fields you have to fill them manually, for example:



  EEvents, ESysInfo;


procedure SetCustomFields(const ACustom: Pointer; AExceptionInfo: TEurekaExceptionInfo; 

  ASender: TObject; AWebFields: TStrings; var ACallNextHandler: Boolean);


  AWebFields.Values['License'] := GetYourApplicationLicense;




  RegisterEventCustomWebFieldsRequest(nil, SetCustomFields);



4. Add any custom data, additional attached files, write necessary event handlers, set exception filters, etc, etc.




1. Test sending. You can do this right in the EurekaLog send options dialog - by clicking on "Test..." button. This will send test bug report.


Suggested actions are:

1. Click on "Test..." button to test sending and creating of a new bug issue in Redmine.
2. Resolve any found issues (access denied, wrong values in fields, etc).
3. Once successful and there is new issue in Redmine - click on "Test..." button again. This should test updating project.
4. Resolve any found issues (access denied, etc).
5. Once successful - close existing test issue in Redmine (as "Resolved"). Optionally - add a comment with special tags (see customizing feedback).
6. Click on "Test..." button again. This should test sending old (already fixed) bugs (see: issues workflow).
7. Ensure there is no error messages, no problems. You should get "success, this bug is fixed" kind of behaviour. Exact behaviour depends on your settings.
8. Delete test issue in Redmine after testing.


These actions should test that sending is actually working.


2. Now it's time to test your application-specific sending.


1. Place debug code in your application to raise a test exception and cause a test leak (if you've enabled leaks collecting).
2. Run your application and invoke this test code.
3. Let application crash and process bug (show dialog, send bug report, etc).
4. Ensure that behaviour is expected.
5. Ensure that you get all files and additional information in Redmine.
6. Remove test code from your application.


Now your application is ready for deployment.



See also:

Send feedback... Build date: 2023-09-11
Last edited: 2023-03-07
The documentation team uses the feedback submitted to improve the EurekaLog documentation. We do not use your e-mail address for any other purpose. We will remove your e-mail address from our system after the issue you are reporting has been resolved. While we are working to resolve this issue, we may send you an e-mail message to request more information about your feedback. After the issues have been addressed, we may send you an email message to let you know that your feedback has been addressed.

Permanent link to this article: