RMClient is the desktop application that tracks time in Jira and Redmine project management systems.
Trial period allows you to use the app within 30 days. You need to purchase a license to continue using RMClient.
Windows 7 and later are supported.
Older operating systems are not supported (and do not work).
To install RMClient on Windows you need to:
- Run the installation file — RMClient. exe;
- Click Install button;
- Confirm installation with the default settings or enter your own;
- RMClient starts automatically after successful installation.
Minimum macOS version supported is macOS 10.10 (Yosemite).
Older operating systems are not supported (and do not work).
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. If needed enter Login and Password of Mac OS user to confirm installation;
5. RMClient starts automatically after successful installation.
Only Ubuntu 12.04 is guaranteed to work,
but following platforms are also verified to be able to run:
- Ubuntu 12.04 and newer
- Fedora 21
- Debian 8
To install RMClient on Windows you need to:
1. Run the installation file — RMClient. deb or RMClient.Appimage;
2. Click Install button;
3. Confirm installation with the default settings or enter your own;
4. RMClient starts automatically after successful installation.
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.
After the RMClient is connected to the Redmine server, the main screen will be displayed. Main screen elements:
- User name;
- the right side of the top panel displays icons: Add Issue, Filter, Search, Update and Settings;
- list of issues;
- left side of the bottom panel displays the number of shown and hidden filtered issues;
- right side of the bottom panel displays the time of last synchronization.
The left side of the top panel displays the User name. Clicking on it will take you to your personal cabinet in Redmine.
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.
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.
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.
An Issue displays:
- Issue subject,
- 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.
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.
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.
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.
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.
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.
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.
Server URL is a path to your Redmine server, for example, someredmine.com or https://redmine.somesite.com.
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».
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.
This option enables logging of technical information that will help us in resolving problems with RMClient and program setting. Active by default.
Activates pop-up notifications about new tasks. Displayed in the lower right corner of the screen.
Active by default.
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.
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.
Activates and displays pop-up notification to leave the comment once the timer stops. Active by default.
Enables the display of all tickets available for the current user. Disabled by default. Activated by cmd+2/ctrl+2.
Enables the display of all tickets where a user is a watcher. Disabled by default. Activated by cmd+3/ctrl+3.
Enables the display of all unassigned tickets available for the current user. Disabled by default. Activated by cmd+4/ctrl+4.
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.
The time interval after which you'll be prompted to start the timer. The minimum value is 5 minutes.
Allows you to set the frequency of synchronization with the server for new issues. The minimum interval is 60 seconds.
Allows you to set the frequency of synchronization with the server for time recording of a current issue. The minimum interval is 60 seconds.
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.
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».
If you use language different from English, you can switch to standard Arial font. Select «Use standard font» checkbox.
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.
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 firstname.lastname@example.org, and we will help you to resolve the problem.
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.
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 RMClient.
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.
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!