YouTrack - EurekaLog Documentation

This is setup options for YouTrack send method (wsmYouTrack). They are located at Sending tab.

YouTrack send method options

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

1. "URL" (.SendYouTrackURL) option specifies target URL for your YouTrack installation. Do not add here "http://" or ":80" parts here. Specify only domain name (or IP) and path. Example: www.example.com/youtrack/

Warning: be sure to setup adequate maximum upload file limits in your web-server/YouTrack configuration. Otherwise sending may fail on large bug reports.

2. "Port" (.SendYouTrackPort) option specifies HTTP port on web server. It's 80 by default. Other common value is 8080. For SSL/TLS it's usually 443. Port will be set automatically to 80/443 by default.

3. "SSL / TLS" (.SendYouTrackSSL) option enabled secure mode (HTTPS protocol). Port will be set automatically to 80/443 by default. Don't forget to adjust port number, if you are using an alternative port number.

4. "Token" (.SendYouTrackPassword) option specifies your account on YouTrack server. This account will be used to submit bug reports. Do not specify e-mail, login, or full user name, use only API tokens. You can create a new API token in your YouTrack profile.

Warning: your real account's data will be stored inside application. Even if it's encrypted - it's still stored inside .exe, so it can be stolen. DO NOT use YouTrack admin account here. Create a new special account for bug reporting via this method. Limit its rights to submitting only. See also: YouTrack setup, Security Considerations.

Note: it is a good idea to disable e-mail notifications for this account.

5. "Proxy" (.SendYouTrackProxyHost, .SendYouTrackProxyPort, .SendYouTrackProxyLogin, .SendYouTrackProxyPassword) options specify proxy details. You can leave them blank to use system-provided settings. Or you can fill these values to set custom proxy.

6. "Connect" button will try to connect to your YouTrack server using the specified URL/port/credentials. If you made a mistake in your configuration - an error message will be displayed. In case of success - field below will be populated from configuration of your bug tracker.

7. "Project" (.SendYouTrackProject) options specifies project name to store bug reports. It's mandatory. Project name is case-insensitive, do not specify project key as name.

8. "Issue type" (.SendYouTrackIssueType) option specifies issue type to create. Mandatory. Default is "Bug".

9. "Assign to" (.SendYouTrackOwner) option specifies owner account name. If this option is empty, all submitted bug reports will be assigned to a default account (configured in YouTrack options). If you enter here any account name - all submitted bug reports will be assigned to this account.

Note: this option is ignored, if submitted bug report already exists (submitting known issue).

10. "Sub system" (.SendYouTrackComponent) option specifies sub system (component) for submitted reports. It's optional.

11. ""Count" field name" (.SendYouTrackCountFieldName) option specifies name of custom field, which EurekaLog will use for bug report counting. While YouTrack have "occurrences"/"count" field: "votes", but you can not alter this field arbitrarily. To workaround this problem, you can create a custom field in YouTrack configuration, which you will use for this purpose. You can enter name of this field here - and EurekaLog will use it to count bugs.

Important: custom field must be present on issue creation page. Otherwise EurekaLog will not be able to fill it. See YouTrack configuration guide.

See also: issues workflow.

15. "Use/fill version field" (.SendYouTrackUseVersion) option instructs EurekaLog to use "Affect Version" field in YouTrack. Disable this option, if you've customized this field and/or use it for other purposes. You can also fill this field manually instead of automatic generation by EurekaLog.

Notes:

•	You must enter valid versions into YouTrack's configuration. You also need to store version information in your executables to fill this field.

•	A project version will be used during sending. The version is extracted from version information of your project's executable.

•	Exception's module version is not used for sending (unless exception's module matches project's module).

•	Obsolete/archieved versions are always excluded from version search.

19. "Require "Released" status" (.SendYouTrackRequireReleased) option will perform version search only on released versions. Otherwise non-released versions will also be used in search.

Because bug tracker may create versions in an arbitrary format (like "Version 1" or "7.3 hotfix 2"), and application uses 4 numbers format (like "7.3.2.0") - EurekaLog has to perform heuristic search. Therefore, it is a good idea to minimize chances of false-positive matches by utilizing additional information, like released status.

We recommend to enable this option for production.

Note: obsolete/archieved versions are always excluded from version search.

20. "Search match up to N numbers" (.SendYouTrackMinVersion) option specifies how version search is performed.

•	First, EurekaLog looks up exact match (e.g. "7.3.2.0" = "7.3.2.0");

•	Second, EurekaLog tries to find version with same numbers (e.g. "7.3.2.0" = "7.3.02.000");

•	Third, EurekaLog performs partial search (e.g. "7.3.2.0" = "7.3.2", or "7.3.2.0" = "7.3", or "7.3.2.0" = "7.3 Beta"). The search is always performed from longer matches to shorter. E.g. when searching "7.3.2.0": "7.3.2" has higher priority than "7.3".

This option indicate when EurekaLog need to stop when searching version:

•	A value of 4 means "all four numbers must match". This is a strict search.

•	Value of 3 means that search would fail if there is no match with at least 3 number (e.g. "7.3.2");

•	Value of 2 means that search would fail if there is no match with at least 2 number (e.g. "7.3");

•	Value of 1 means that search would fail if there is no match with at least 1 number (e.g. "7").

We recommend to use value of 4 for this option, because it greatly reduces possible ambiguity. However, it will mean that you have to enter each build (even very minor one) of your application in your bug tracker's configuration.

Value of 1 means using very wide criteria. We do not recommend to use it. If you are still going to use it - be sure not to enter too much sub-versions in your bug tracker, especially with added text.

Values of 2 and 3 are a good compromise.

21. "Upload bug report files for duplicates until bug is closed" (.SendYouTrackUploadFilesForDups) option allows you to collect all bug reports. If this option is unchecked (default): only first bug report is uploaded and stored. All other bug reports for the same problem (identified by BugID) will be discarded. Only "count" field will be increased (if it was configured). If this option is checked: bug reports for the same problem will be uploaded to issue.

Notes:

•	if you check this option be sure to name bug report files in unique way to avoid file names duplicates. Also, be sure to have a lot of hard disk space to store all bug reports.

•	bug reports will not be uploaded, once the issue is closed or resolved.

•	you can also stop collecting files by changing status to "In progress".

Root > Integral parts > Options > Report sending page > YouTrack YouTrack