Saber Feedback Documentation

Redmine Integration

Requirements:

  • Redmine version 1.4.0 or newer
  • REST Authentication Enabled
  • At least one Project with Issues enabled

How to check your Redmine Version

Saber is only able to integrate with Redmine servers running version 1.4.0 or greater. v1.4.0 was released in April 2012. you can find out which version of Redmine you are running by logging into your Redmine server using an Administrator account, and clicking Administration from the top-left menu:

Redmine Vesrion Check Stage 1

Then click Information from the administration menu:

Redmine Vesrion Check Stage 2

This will take you to a page that displays your Redmine version, eg:

Redmine Vesrion Check Stage 3

How to enable REST Authentication

To enable REST Authentication, log into your Redmine server using an Administrator account, and then click Administration from the top-left menu:

Redmine Enable REST Stage 1

Then click Settings from the administration menu:

Redmine Enable REST Stage 2

Then click Authentication from the tabs, make sure the Enable REST web service checkbox is checked, and then click the Save button:

Redmine Enable REST Stage 3

How to enable Issues on a Project

Navigate to a project in Redmine, and then click its Settings tab:

Redmine Enable Issues Stage 1

Then choose the Modules tab under Settings, make sure the Issue tracking checkbox is checked, and then click the Save button:

Redmine Enable Issues Stage 2

How to find your API Key

Log into your Redmine account, and click on My account from the top-right menu:

Redmine Find API Key Stage 1

On the right hand side of this page you should see a grey box with API access key followed by show

Redmine Find API Key Stage 2

Note: If you don’t see this, you need to first enable REST Authentication (see above)

Click on Show to reveal your API Key, which you can then copy for use in Saber.

How to set up a Redmine integration in Saber

Paste your API key into the API Key field, and the root URL of your Redmine server in the URL field. You can find your Redmine server’s root URL by logging into your account and then clicking Home from the top-left menu, and copying the address you navigate to.

Once you’ve entered both your URL and API key, click the Authenticate button:

Redmine Setup Stage 1

You will then be able to set up your Redmine integration:

Redmine Setup Stage 2

Subject

Required

This allows you to define the naming format of the Redmine issues submitted through Saber. If the name contains {{summary}}, this will be replaced with a summary of the feedback reports description. See Feedback Summary for more details.

Project

Required

Here you can choose in which project you would like Saber to post feedback reports.

Test Settings

All integrations include a test button, which allow you to check the options you’ve specified are working correctly. Clicking the Test Settings button will send a sample feedback report using the data from the form to your Redmine account.

Clicking test settings does not save the integration, you will still need to click the Save once you are happy with settings.