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 JIRA itself - please see this article. The text below assumes that you already completed JIRA installation.
Below are detailed steps for recommended JIRA setup for automatic bug report submission. Before going through setup - make sure to upgrade your JIRA 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:
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.
Creating custom fields
1. (Administration/Custom Fields) Create custom field 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) and "e-mail" ("user e-mail", which is typically entered in MS Classic error dialog). Both fields should be text fields. Again, field names can be anything.
We strongly recommend to create at least "Count" and "BugID" fields.
Example: two new custom fields
2. Create any other additional fields as you need/like (you can submit values for custom fields at run-time via OnCustomWebFieldsRequest event). Note that you can use "|" symbol (vertical bar) to separate individual values for multi-select custom fields.
Important: Be sure that custom fields are present on issue submission page. Otherwise EurekaLog will not be able to fill them. If some fields are missing - you has to configure your screens.
Verifying fields on "Create Issue" page
Creating user accounts
1. (Administration/Users) Create new non-admin user account for bug report submission. Create it with disabled e-mail notification:
Creating new user
Important Note: please remember username of new account. You will be using it later - when entering login credentials into EurekaLog. Do not use e-mail or full name.
2. Click on "Edit groups" link and add user into developers group (users group have read-only access; developers group have read-write access; administrators group have full control access):
Including account into groups
3. Repeat these steps for each bug submitter user account which you want to create.
4. (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
Associating role with group
5. (Optional) Open bug reporting user account and include it into a bug reporting group:
Suggested group setup for bug reporting user accounts
Repeat this for all bug reporting accounts.
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
2. (Optional) Create components for the projects. Typically component is used for identification of the part of your software product.
Creating component(s) for the project
3. Create versions for the project. If you don't use versioning (highly unrecommended) - you can skip this step.
You should create new version for each release of your software. I.e. when you release (publish on site, send to custom, etc) "YourSoftware 220.127.116.11" - you need to create "18.104.22.168" version. When you release update: "YourSoftware 22.214.171.124" - you need to add "126.96.36.199" version.
Version strings can be arbitrary like "1", "1.0", "1.0.1", "188.8.131.52" or even "184.108.40.206 beta 3". However, it's recommended to use four-number versions with optional textual description, for example: "220.127.116.11" and "18.104.22.168 beta 3".
Note: if you don't want to edit project each time you release new version - you can create versions for the future use. I.e. when you release "YourSoftware 22.214.171.124" - you can create "126.96.36.199", "188.8.131.52", "184.108.40.206", "220.127.116.11"..."18.104.22.168" versions.
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.
Important Note: EurekaLog will only for "Released" versions, if a corresponding option is enabled. Be sure to mark versions of your compiled .exe as "Released" in JIRA.
4. Setup project access rights: permissions and roles.
Enabling external access to bug tracker
1. (Administration/General Configuration) Enable access to bug tracker via API calls:
Enable "Accept remote API calls" option
Note: this option is enabled by default on JIRA cloud accounts. It is also may be unavailable in some JIRA server installations. Please, refer to documentation for your JIRA version for more information.
1. Enter JIRA details into EurekaLog configuration of your projects:
JIRA settings filled into EurekaLog options
Important Note: use your username as login. Do not use e-mail of full name. You are specifying username when creating account for reporting:
Username when creating new account
If you forgot your username, you can always find it in your profile or user management:
Locating username of already created accounts
3. Set/fill custom fields. EurekaLog has support for automatic managing of "Count", "BugID" and "E-Mail" fields. You just need to enter field names in EurekaLog options. For other custom fields you have to fill them manually, for example:
procedure SetCustomFields(const ACustom: Pointer; const ASender: TObject; const AWebFields: TStrings; var ACallNextHandler: Boolean);
AWebFields.Values['License'] := GetYourApplicationLicense;
AWebFields.Values['Tags'] := 'EXE|CRASH|AUTOREPORT';
Note that you can use "|" symbol (vertical bar) to separate individual values for multi-select custom fields.
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:
These actions should test that sending is actually working.
2. Now it's time to test your application-specific sending.
Now your application is ready for deployment.
1. You need to create or update project versions when you ship new release of your software. If you've created a batch of versions in JIRA for future use - you may skip it until you've run out of versions.