Help

  • All
  • Introduction
  • Install and Update
  • Main screen
  • Settings screen
  • Troubleshooting
  • License
  • Hot keys
What is FORFORCE Redmine Client?

FORFORCE Redmine Client is the app that tracks time in Redmine project management system.

Introducing FORFORCE Redmine Client

After RMClient installing it is necessary to enter two parameters: Server URL (path to your Redmine server, for example, http://someredmine.com) and API Key (authorization key in your Redmine).

RMClient - Login screen

FORFORCE Redmine Client interface

After the FORFORCE Redmine Client is connected to the Redmine server, the main screen will be displayed. Main screen elements:

RMClient - Main screen

Trial period of the program

Trial period allows you to use the app within 30 days. You need to purchase a license to continue using RMClient.

RMClient - Trial period expired

User name

The left side of the top panel displays the User name. Clicking on it will take you to your personal cabinet in Redmine.

Add issue

Add Issue feature is activated after installation of Add Issue Plugin to your Redmine (download plugin).

This feature allows to select a project and create an issue in it. In the «Add Issue» screen you'll see similar to web version fields. Files attachment is also available in accordance with your server settings.

To create a new issue:

  1. Select a project;
  2. Fill in all required and, if necessary, additional foelds;
  3. Press «Create» button.

After you create an Issue, you can start tracking it immediately or create another one.

Filter

Filter allows you to select which issues to show using the following criteria:

  • Project — the list of the projects names with issues assigned to you.
  • Tracker — the list of trackers.
  • Status — the list of statuses.
  • Priority — the list of priorities.
  • Version — the list of versions.

In order to apply filter select the appropriate combination of fields and click Apply. To reset the filter, click Reset.

Selecting different parameters help you to more quickly find the required issues. For example, with the Status field you can select all New issues and then filter them by priority.

Note. Selection of fields is interdependent. Selecting a specific Project, other fields will display all of the options, but only those will be active that are available in the issues of the selected project. It works with all filter fields.

RMClient - Apply a filterRMClient - Filtered tasks

Search

Search allows you to find a specific issue by a word or phrase and is performed by all issue fields that are displayed in RMClient. The exception is the time spent on the issue.

After entering the first symbol, the issues will be filtered out. Those ones under your search criteria will be active, as well as the running issue, the rest will be «darkened». In case there is no match you will see Not found.

RMClient - SearchRMClient - Search results

Update

This button allows you to instantly synchronize RMClient with your Redmine server.

RMClient - Update

Settings

This button leads you to the Settings screen.

List of Issues

Displays all the issues assigned to you. Issues from one project are highlighted by the same color and are sorted out according to priority. If the number of issues exceeds than screen available you may scroll the list up and down.

Issue

An Issue displays:

  • Issue subject,
  • Priority,
  • issue id in Redmine,
  • Project name,
  • First lines of the Issue's description,
  • Time spent at the moment,
  • Estimated time.

The name of the Issue is the link to the issue in Redmine.
Priority, issue id in Redmine and the Name of the project are links to the project issues in Redmine.

When you move a mouse cursor on the Issue, Favorite, Edit and Start icons appear.

When you click Favorite button, a ticket is displayed at the top of the list.

To start the time tracking click the Start button or click twice on the issue. After start an Issue with active timer is shown.

You can disable the Estimated time field in Settings.

An Issue with active timer

After you start an Issue, its color changes to red and it moves to the first position in the Issue list. Above the Issue subject appears time counting and additional fields below: Activity and Status. This allows you to change the status according to the stage of work.

Instead of Start icon a Pause icon appears, clicking on which stops the time counting in an Issue.

After stopping the timer, an Issue gets he colour obtained when loading an Issue list and returns to its initial position.

Favorite

When you click «Favorite» button, your ticket is displayed at the top of the list. This allows to quickly find important or frequently used tickets.

Main-screen - FavoriteMain-screen - Favorite - clear

Issue editing

With the help of this window you can update Issue Status, leave a comment to an Issue, change other parameters and assign it to another user without a need to go to the Redmine web version.

To open the window, click the Edit button, that appears when hovering over an Issue with both active and inactive timer.

The editing window displays:

  • Issue introduction (displays information similar to the info in the Issue List);
  • Standard fields: Status, Priority, Assignee, Start date, Due date, Estimated time, Done, Version;
  • Additional fields (depending on the settings in your Redmine);
  • Comment field;
  • Adding files to am Issue (Attach files (Beta)).

To add file (s) to an Issue click Attach files (Beta), select a file, enter description and click Submit. The default size limit for each file is 97.7MB. The maximum file size depends on the server settings. This feature is still in Beta, full operability is not guaranteed.

To save the changes click Submit. If any of the required fields is blank, an error message is shown. Fix it and click Submit again.

The name of the window contains the Issue number, that helps to quickly find the necessary Issue among the open ones.

RMClient - Issue editing

Adding notes to an Issue

To leave a comment to the Issue you need to:

  • click on the Edit icon;
  • enter your comment in Notes;
  • click Submit.

In order to successfully leave a comment you need to fill all the required fields in, if any.

Activity and Status


The list of activities and statuses available in Redmine corresponds to the current Issue and appears after its launch. Allows you to change the status and set a variety of activities for the time recorded, without the need to open it in your browser.

RMClient - ActyvityRMClient - Status

Settings screen

Settings screen allows you to change the status of customizable functions and additional fields in RMClient. To change the connection parameters with Redmine server or License Key, the following fields are used: Server URL, API Key, License Key. To save changes, press Sign in button.

RMClient - Settings screen

Server URL

Server URL is a path to your Redmine server, for example, someredmine.com or https://redmine.somesite.com.

RMClient supports web authorization in Server URL field (example: webname:webpass@redmineserver)

Where can I find my API Key?

API Key is available on the Settings page in your Redmine account (http://someredmine.com/my/account). On the right of «My Account» page you can find a title «API access key», click «Show». If you can’t find the «API access key» title on «My Account» page, you need to enable «REST Web Service».

RMClient - Redmine API access key

How to enable «REST Web Service»?

Redmine administrator can enable «REST Web Service». To do this, open the Settings / Authentication (http://someredmine.com/settings?tab=authentication), use the «Enable REST Web Service» option and save the settings.

What is a License Key? How to get it?

License Key allows you to use FORFORCE Redmine Client after trial period. Get your license now.

Log

This option enables logging of technical information that will help us in resolving problems with FORFORCE Redmine Client and program setting. Active by default.

Enable pop-up notification

Activates pop-up notifications about new tasks. Displayed in the lower right corner of the screen.
Active by default.

RMClient - New task

Track the estimated time

Activates and displays Estimated time. Is displayed under the value of spent time in the list of issues. Pop-up notification is displayed when user reaches the estimated value. Inactive by default.

Track the time of inactivity

Activates pop-up nitifications when user's inactive for nore than 5 minutes. Pop-up includes a timer, that counts the idle time since appearance, as well as a list of tasks and filter. After returning to the workplace, a user can add idle time to the relevant task or reset the time of inactivity. Inactive by default.
This function works incorrectly for Linux users through Wine.

RMClient - No activity

Confirm application exit

Activates and displays a confirm pop-up notification before exit. Active by default.

Reminder to comment the spent time

Activates and displays pop-up notification to leave the comment once the timer stops. Active by default.

Show all Issues

Enables the display of all tickets available for the current user. Disabled by default. Activated by cmd+2/ctrl+2.

Show issues where I’m a watсher

Enables the display of all tickets where a user is a watcher. Disabled by default. Activated by cmd+3/ctrl+3.

Show unassigned issues

Enables the display of all unassigned tickets available for the current user. Disabled by default. Activated by cmd+4/ctrl+4.

Enable reminder to start the timer

Activates and displays a reminder that the timer is OFF. Notification is shown after a time you have specified in «Remind me to start the timer» field.

Remind me to start the timer (min)

The time interval after which you'll be prompted to start the timer. The minimum value is 5 minutes.

RMClient - Remind me to start the timer

Issue list update timeout (sec)

Allows you to set the frequency of synchronization with the server for new issues. The minimum interval is 60 seconds.

Time entry update timeout (sec)

Allows you to set the frequency of synchronization with the server for time recording of a current issue. The minimum interval is 60 seconds.

The time is not recorded / the timer is not displayed properly. What’s the problem?

You need to install the latest version of Adobe AIR. You can download it here.

The timer will not record the time, if your Redmine user doesn’t have appropriate access privileges.

You need to check in your account settings whether you have the permission to record, view, and edit the time spent on the project. Select the «Members» tab in project settings and check the role assigned to the specific user.

To check the rights available for the role, you need an access to administration panel in Redmine. You can edit all rights including time recording right in «Roles» in «Administrative Tools».

Non-Latin characters are not displayed in the Task list. What to do?

If you use language different from English, you can switch to standard Arial font. Select «Use standard font» checkbox.

Installing on Windows

To install RMClient on Windows you need to:
1. Run the installation file — RMClient. exe;
2. Click Install button;
3. Confirm installation with the default settings or enter your own;
4. Accept Adobe System Incorporated license agreement;
5. RMClient starts automatically after successful installation.

RMClient requires the Adobe AIR runtime. If it isn't installed, the installer will make this automatically.
You can install Adobe AIR by yourself by downloading the installation file here.

Everything is OK with access rights, but the time is not recorded to the Issue. What’s the reason?

Probably you have configured «Activity» field in Redmine as required. To remove this restriction, you need to go to your_redmine_url/enumerations/ and choose default value to some kind of activity.

I’ve downloaded RMClient. air setup file, but it doesn’t start. What to do?

You need Adobe Air runtime to install and run RMClient. You can download it here.

I found the problem, what's next?

If you are unable to solve the problem, you can turn on logging in the client settings by checking the «Log» box. Now, all of your activities will be written to a text file, which can be found in «My Documents» folder — «RMClient». You can send us the log to support@rmclient.org, and we will help you to resolve the problem.

I lost my internet connection during the work of RMClient. What to do?

In case of loss connection with the server, there are attempts to automatically connect, and pop-up warning notification. Click «Try again» to re-connect to the server and once it is made, your time will be recorded in the Redmine database. If you click «Cancel» your time won't be recorded.

How to purchase a license key?

To get a license key please follow the link «Purchase a license» and choose the most suitable pricing. Fill in a form. Make a payment in any convenient way for you: by Credit/Debit card, PayPal, etc.

After the payment is confirmed, you will receive a License Key. Please enter the key into the required field in FORFORCE Redmine Client.

What is License Key for? How to get it?

License Key allows you to use FORFORCE Redmine Client after trial period has expired. Get a license right now.

Discount

When purchasing a license you are able to choose the most advantageous price. You get 10% or 20% off when purchasing 10−20 or 21−50 licenses accordingly. Learn more about RMClient pricing.

When trying to update the client, the following message is displayed: Error #0.

Error #0 usually appears when a user that installs the programm doesn't have administrative rights, or because of the error in the Windows registry.

To solve the problem you need:

Option 1. Log in as administrator, run the program and install an update. If you don't know how to do this, please contact your system administrator.

Oprion 2. Use the following link to run the troubleshooter http://support.microsoft.com/mats/Program_Install_and_Uninstall/en-us. Then run the program and install an update.

What to do if I haven’t received a License Key after I bought it?

Please send an e-mail to support@rmclient.com or fill in a form. Please indicate your Order ID so that we can respond to your request quickly and effectively.

Special offers

We regularly hold promotions and distribution of promo-codes. Follow us on Facebook or subscribe to our Newsletter and don't miss a special offer!

Installing on Mac OS

To install RMClient on Mac OS you need to:
1. Run the installation file — RMClient.dmg, then — Install RMClient;
2. If there is a window notifying that the file was downloaded from the Internet, click Open.
3. Confirm installation with the default settings or enter your own, click Continue;
4. Accept Adobe System Incorporated license agreement;
5. If needed enter Login and Password of Mac OS user to confirm installation;
6. RMClient starts automatically after successful installation.

RMClient requires the Adobe AIR runtime. If it isn't installed, the installer will make this automatically.
You can install Adobe AIR by yourself by downloading the installation file here.

Installing on Linux

To install RMClient on Linux you’ll need Wine. If Wine is already installed go to the next step.

  1. If you use Ubuntu, install Wine Windows Program Loader using the Ubuntu Software Center. In case of difficulties, please check information provided on the websites: If you use other Linux platforms, follow this link https://www.winehq.org/download/ and select version for your platform.
  2. To start the installation process of RMClient. exe, please select: open with — Wine.
  3. Confirm the installation with the default settings or enter your own. RMClient requires Adobe AIR runtime, it will be installed automatically.
  4. Accept Adobe System Incorporated license agreement.
  5. RMClient starts automatically after successful installation.

This description is based on the RMClient installation on Ubuntu 14.04.1 (x64-x86), but is also valid for other systems that support the technology used in Wine (https://www.winehq.org/).

Update

We announce to our customers the releases of RMClient new versions in Newsletters and posts on www.facebook.com/rmclient. An update is available to the customers with paid license and for those who use free 30-days trial.

After the new version release, when starting RMClient, the app will offer to download and install the new version.
A notification will display the Installed version and Version available to update, as well as short description of the changes in current version.

To install the update you need to:

  • click «Download now» in the window that appears when you run RMClient;
  • after the download is complete, click «Install» and update the app now, or choose the update after you restart the app.

When you choose to update the app immediately, the client will be closed automatically and updated.

While updating all data entered in Settings window, is stored.

The update process is similar for all supported platforms.

Error: «Invalid application descriptor».

In case of error during installation caused by emergency power-off of the device or other factors, the following Pop-up may occur:

Invalid application descriptor


To fix the problem reinstall FORFORCE Redmine Client following the instructions.

Sign in and Cancel buttons

These buttons allow you Apply the changes to the settings or undo them accordingly. If the information to connect was entered correctly, after you click any of the buttons you'll go to the Main screen.

Note. When you click Sign in button, RMClient reconnects to the server, that leads to the issue list update and stops the timer in active Issue.

cmd+1/ctrl+1

tickets assigned to you

cmd+2/ctrl+2

tickets where you’re a watcher

cmd+3/ctrl+3

all tickets you have access to

cmd+4/ctrl+4

show unassigned tickets

cmd+W/ctrl+W

minimize RMClient to system tray