Redmine

The Redmine plugin is used on the integration of BizDock and a Redmine. Redmine is a flexible project management web application. Written using the Ruby on Rails framework, it is cross-platform and cross-database. Redmine is open source and released under the terms of the GNU General Public License v2 (GPL) See http://www.redmine.org/ for more details about the software.

Data Type

The Redmine Plugin is working with the following Data Types:

Data exchange

Events

The Redmine Plugin is treating the following Events:

  • IN events (Redmine to BizDock): none
  • OUT events (BizDock to Redmine): none

Scheduler

The Redmine Plugin is managing the following Schedulers:

  • Load the Redmine's issues as Requirements and the Redmine's versions as Iterations, see the integration page for more details

Manual

The Redmine Plugin is managing the following manual actions:

  • Create a Redmine's project with the Initative data, see the integration page for more details

Admin Commands

This Plugin does not provide any Admin Command.

Configuration

Global properties

Name Description Example
redmine.host.url The url of the Redmine instance. https://redmine.the-agile-factory.com
redmine.api.key A valid key for Redmine API. The key should grant all access and the associated User must be Administrator
is_scoped.custom_field.id The Redmine custom field ID that represents the “is scoped” information. It will be synchronized with the “Scoped” attribute of a BizDock requirement. The format should be a boolean. Simply let it empty if you don't use this concept. 4
story_points.custom_field.id the Redmine custom field ID that represents the “story points” information. It will be synchronized with the “Story point” attribute of a BizDock requirement. The format should be a numeric (integer, float…). Simply let it empty if you don't use this concept. 7
remaining_effort.custom_field.id The Redmine custom field ID that represents the “remaining effort” information. It will be synchronized with the “Remaining effort” attribute of a BizDock requirement. The format should be a numeric (integer, float…). Simply let it empty if you don't use this concept. 8
pe.iterations.filter The filter for the iterations. The format should be “{Redmine custom field name}={BizDock field name}”.
{Redmine custom field name} represents a custom field of the Redmine versions, the pattern to use is “cf_{id}”.
{BizDock field name} could represent an Initiative attribute (name, description…) or the ID of a custom attribute.
If empty, then no filter is applied (all versions of the Redmine project are loaded).
cf_12=name (meaning all Redmine's versions for which the value of the custom field 12 is equal to the Initiative name)
pe.needs.filter The filter for the needs. The format should be “{Redmine field name}={BizDock field name}”.
{Redmine field name} could represent the “category” attribute of the Redmine issues or a custom field. In case of custom field, this last should be marked as “Used as a filter” and to reference it the pattern “cf_{id}” should be used.
{BizDock field name} could represent an Initiative attribute (name, description…) or the ID of a custom attribute. Due to a Redmine limitation, the custom attribute SHOULD have a default value that is NOT empty.
If empty, then no filter is applied (all needs of the Redmine project are loaded).
category=name (meaning all Redmine's needs for which the category value is equal to the Initiative name)
pe.needs.trackers List of Redmine tracker IDs for which an issue is considered as a need. 2;4
pe.defects.filter Same than “pe.needs.filter” but for the defects. cf_4=INITIATIVE_COMMENT (meaning all Redmine's defects for which the value of the custom field 12 is equal to the Initiative custom attribute with ID INITIATIVE_COMMENT)
pe.defects.trackers list of Redmine tracker IDs for which an issue is considered as a defect. 1
pe.load.start.time Define when the load should start (time). Default value is 03h00. 08h00
pe.load.frequency Define how regularly (in minutes) the load should run. 60

Requirement status mapping

Mapping between the Redmine and the BizDock status. Each row is represented by “{Redmine status ID}={BizDock status ID}”, for example “2=4”.

Requirement severity mapping

Mapping between the Redmine priorities and the BizDock severities. Each row is represented by “{Redmine priority ID}={BizDock severity ID}”, for example “2=4”.

The BizDock severities are mapped with the Redmine priorities because Redmine doesn't manage the severities concept.

Requirement priority mapping

Mapping between the Redmine and the BizDock priorities. Each row is represented by “{Redmine priority ID}={BizDock priority ID}”, for example “2=4”.

Good to know / Debug

Sometimes, the synchronisation will not work because of some incorrect Redmine configurations:

  • The Redmine API that you are configurating in BizDock must be the one of an “admin” user in Redmine. This is required to properly call the Redmine User API.
  • The Redmine Modules “Issue Tracking” and “Time Tracking” must be activated. You will see errors in the BizDock Plugin logs otherwise.