BeatMinefor Redmine
BeatMine for Redmine

Support

Connection instructions, everyday use, and help when you need it.

What you need

  • Redmine 6.0, 6.1 or 7.0.
  • You can open that Redmine over HTTPS from this device.
  • The REST API is enabled in Redmine (a setting for your Redmine administrator).
  • Your API key. If you don't have it at hand, use “Get the API key in Redmine” on the connection screen.

Environments that don't work are listed under “Not supported”.

Getting started

  1. Open the app and enter your Redmine URL.
  2. Tap “Get the API key in Redmine”. Redmine opens in your browser. Sign in and copy the API key shown. Return to BeatMine and tap “Paste and connect”. If you already have your API key, you can enter it and tap “Connect”.
  3. Your task list appears.

How to use

  • Only unfinished tasks assigned to you, or to a group you belong to, are listed. Tasks assigned to a group show the group name. Overdue tasks are shown in red.
  • Swipe a task right to complete it. You can undo it right away.
  • Tap a task to read its description and attachments. Images open in the app and can be zoomed. Tasks with a description or attachments show an icon on their row.
  • Tap a task to read its earlier comments, newest first. Comments you wrote are shown as “You”. A dot appears on the row of a task that was updated since you last opened it.
  • “Write comment” lets you send a comment while reading the earlier ones. It is saved in the Redmine history.
  • When the listed tasks belong to two or more projects, the “Filter” icon next to the title lets you filter the list by project. The projects you choose are kept the next time you open the app.

If something goes wrong

Look for the message shown on the screen.

When connecting

If you see “Can't connect to Redmine.”, check the cause. A wrong URL or API key is shown under that field. Other causes are shown when you tap “Details”.

CauseWhat you can do
“The Redmine URL is incorrect.”Open the URL in your device's browser. If it doesn't open, the URL may be mistyped, or you may be trying to reach an internal-only Redmine from outside your organization.
“The API key is incorrect.”Enter the API key again. Tap “Get the API key in Redmine”, then copy and paste the API key shown. This app can't be used if there is another sign-in (such as Basic authentication) in front of Redmine.
“The Redmine API is disabled. Ask your Redmine administrator to enable it.”Ask for the REST API to be enabled in Redmine.
“Can't verify Redmine's certificate.”This device can't verify the certificate of your Redmine. Redmine servers that use a private certificate (one issued only within your organization) are not supported. This message also appears if you haven't finished signing in to a Wi-Fi network, or if the device's date and time are wrong.

When loading, completing or commenting

MessageWhat you can do
“Network error”Try again where you have a signal. This also appears when Redmine is temporarily not responding.
“Updated by another user. Please reload.”Someone else changed the task. Reload, check its current state, and then try again.
“You don't have permission to complete this.” (a similar message appears for commenting and loading)This is not allowed in your Redmine. Ask your Redmine administrator.
“Has unfinished subtasks.”Complete all subtasks first.
“Blocked by an unfinished task.”Complete the blocking task first (shown under “Related issues” in Redmine).
“The change couldn't be made.”Redmine did not accept the change. This happens when a field must be filled in to complete the task. In that case, complete it in Redmine.
“Couldn't confirm that it was sent. Please reload.”The app couldn't confirm whether your update reached Redmine. Reloading checks again.
  • If Redmine can be reached but the app still can't confirm the update, it stops checking so you can carry on with your next report.
  • While Redmine can't be reached (for example, with no signal), you can't complete or comment on other tasks until the update is confirmed. However, if two reloads in a row can't confirm it, the app stops checking (the count continues even if you reopen the app).
  • A comment the app stopped checking stays as a draft. It may actually have arrived, so sending it again may post it twice.
“Something went wrong in the app. Please reload.”If reloading doesn't fix it, your Redmine may not be supported (for example, older than 6.0).

When viewing descriptions and attachments

MessageWhat you can do
“Can't open in the app”Only images (JPEG, PNG, GIF, WebP, HEIC) up to 20 MB open in the app. Open PDFs and other files in Redmine.
“Couldn't open the link.”A link in the description couldn't be opened in the device's browser. You can select and copy the description text with a long press, then paste it into the browser.

Messages such as “Network error” when opening an image mean the same as under “When loading, completing or commenting”. Tap “Try again” to load it again.

If earlier comments can't be loaded, “Comments: couldn't load” appears, and the comments section shows the reason and “Try again”. The reasons are the same as under “When loading, completing or commenting”. You can still complete the task and send comments.

Other common questions

A completed task got an unexpected status (such as “Rejected”)
The app uses the first closed status you're allowed to set for that task, in Redmine's status order. The status used is shown in the completion notice. Tap “Undo” on the completed task (or in the notice) to revert it. You can't undo after reloading the list, or if Redmine doesn't allow changing the status back. In that case, change it back in Redmine. If your Redmine administrator changes the status order (putting “Closed” above “Rejected”), a different status is chosen.
I was asked for my password when getting the API key (Redmine 7.0)
Redmine asks for your password again some time after you sign in. Enter it to see your API key.
The list shows fewer tasks than expected
If the task count says something like “(2 projects selected)”, the list is filtered by project. Turn it off with the “Filter” icon next to the title. The icon appears only when the listed tasks belong to two or more projects.
Some tasks are missing from the list
The list shows only tasks assigned to you, or to a group you belong to, that are not closed and whose start date is not in the future. Tasks in closed projects are not shown. The list is not filtered by due date.
Who does a group's task?
The app doesn't decide. Talk it over within the group, or reassign the task to a person in Redmine. When a group's task is completed, it also disappears from the lists of the other people in the group.
Symbols such as “h2.” or “*” appear in a description
The app formats descriptions as Markdown, handling only headings, lists, bold text, links and code. Descriptions written in Textile, tables and embedded images are shown as plain text.
Before passing on or disposing of your device
“Delete connection” in “Settings” removes your API key, comment drafts, records of unconfirmed updates, your project filter and the record of tasks you opened from the device.

Not supported

The following may work, but have not been tested.

  • Redmine older than 6.0
  • Redmine with plugins
  • Hosted Redmine services (My Redmine, Planio and others)
  • Private certificates issued only within your organization
  • Authentication in front of Redmine (such as Basic authentication)
  • SSO

Contact

Please send bug reports and feedback by email.

potei_eisu2@yahoo.co.jp

If you have a GitHub account, you can also use GitHub Issues. Issues are public.

Please don't include your API key, passwords, Redmine URL, task details or anything else you want to keep private. Including the following information helps us respond faster.

  • The app version (Settings > General > iPhone Storage > BeatMine. Leave it out if you can't find it.)
  • Your iPhone model and iOS version
  • Your Redmine version (if you know it)
  • The message shown on the screen (such as “Network error”) and what you were doing