RMClient is the desktop application that tracks time7 in Jira and Redmine project management systems.

Also RMClient supports Easy Redmine, Planio, etc.

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

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

Windows 7 and later are supported.
Older operating systems are not supported (and do not work).

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. 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.

How to open a blocked app

  1. Open System Preferences.
  2. Go to Security & Privacy and select the General tab.
  3. If you've been blocked from opening an app within the past hour, this page will give you the option to override this by clicking the temporary button 'Open Anyway'.
  4. You'll be asked one more time if you're sure, but clicking Open will run the app.

How to 'Allow Apps from Anywhere'

But there is a third, hidden option: 'Allow apps from anywhere'. This used to be an option in earlier versions of macOS, but disappeared when macOS Sierra arrived. However you can get the Anywhere option back.

We will say right away that we don't recommend this setting, which puts you at risk of installing malware under the guise of legitimate software. But if you are determined on this course, it's possible to make that option reappear with a line of code in Terminal.

Open Terminal and enter the following code to get your Anywhere option:

sudo spctl --master-disable

Now press Return, and you will be asked to enter your password. Once that's done, open System Preferences (if it's already open, you'll need to quit it and restart to see the new options) and go to the Security & Privacy section.

How to remove the 'Anywhere' option

If you share your Mac with someone else it might be wise to get rid of the Anywhere option. To hide it again, you'll need to go to Terminal again, and this time type:

sudo spctl --master-enable

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.

You can find description about latest releases here.

Экран Логина позволяет, создать новое подключение или выбрать уже созданное подключение и авторизоваться в приложение. 

Экран Логина содержит:

  • номер текущей версии приложения - отображается в верхнем левом углу окна
  • ссылка Help - позволяет перейти на раздел сайта https://rmclient.org/ru/help
  • поле Connections - список типов соединения 
  • поле ServerUrl - адрес Вашего сервера Redmine
  • поле API Key - ключ доступа к Вашему серверу Redmine
  • поле License Key - номер Лицензионного ключа. Позволяет пользоваться приложением после окончания ознакомительного периода.
  • кнопки Log in и Delete Connections
  • Log - активирует логирование технической информации, которая поможет нам в устранении проблем с работой или настройкой RMClient.

Для изменения параметров соединения с сервером Redmine или Лицензионного ключа используются поля: ServerUrl, API Key, License Key.

Создание нового подключения

При создании нового подключения Пользователю необходимо:

  1. Выбрать в поле Connections тип соединения Redmine 
  2. Заполнить поля (Client, ServerUrl, API Key, License Key)
  3. Подтвердить действие нажатием кнопки Log in.

 

Авторизация в приложение

При авторизации Пользователю необходимо:

  1. Выбрать в поле Connections тип соединения Redmine 
  2. Заполнить поля (ServerUrl, API Key, License Key)
  3. Подтвердить действие нажатием кнопки Log in.

 

После введения корректных данных в поля ввода Пользователь попадает на Основной Экран. При вводе ошибочных данных в поля для ввода, появляется соответствующая подсказка и поле выделяется.

Изменение параметров соединения

Для изменения параметров соединения с сервером Redmine или Лицензионного ключа используются поля: ServerUrl, API Key, License Key.

Чтобы удалить настройки существующего соединения необходимо нажать Delete Connection

Изменение типа соединения

Для того, чтобы изменить тип соединения необходимо в поле Connections выбрать необходимый из доступных в списке.

После выбора ранее регистрируемого типа соединения, введенные значения в поля восстанавливаются и доступны к редактированию.

В случае выбора нового типа соединения, поля очищаются и их необходимо заполнить.

Server URL is a path to your Redmine server, for example, http://rm.MyCompany.com.

API Key is available on the Settings page in your Redmine account (http://rm.MyCompany.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

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

License Key allows you to use RMClient after trial period. Get your license now.

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

RMClient - Main screen

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.

RMClient - Apply a filter RMClient - Filtered tasks

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 - Search

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

This button leads you to the Settings screen.

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,
  • 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.

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.

Main-screen - Favorite Main-screen - Favorite - clear Main-screen - Favorite - clear

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 RMClient - Issue editing, Attachments RMClient - Issue editing, Custom Fields

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.

RMClient - Activity RMClient - Status

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 RMClient - Settings screen

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.

RMClient - New task

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.

RMClient - No activity

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

Настройка Stop tracking time in Sleep mode позволяет остановить таймер задачи, когда Ваш персональный компьютер перешел в режим сна, и без потери данных записать время, потраченное на задачу.

Как включить либо отключить функцию остановки таймера, когда ваш ПК перешел в режим сна?

Настроить остановку таймера, когда ваш ПК перешел в режим сна, можно включить и выключить в Настройках Stop tracking time in Sleep mode.

Откройте в приложение Экран настроек. В нижней части окна выберите настройку Stop tracking time in Sleep mode.

Затем нажмите на Stop tracking time in Sleep mode или переведите переключатель «Разрешить уведомление» в положение «Вкл.» При этом цвет переключателя изменится с черного на серый. Теперь настройка Stop tracking time in Sleep mode активирована.

Точно так же Вы сможете отключить настройку Stop tracking time in Sleep mode, изменив положение переключателя на "Выкл."

Активирует функцию анимационного уведомления при получении новых задач. 

Если Вам назначена новая задача, в правом нижнем углу экрана на иконке RMC будет показана мигающая цифра.  Цифра показывает количество новых задач.

Вы также получите уведомление, если у вас запущена Задача с активным таймером.

Кликнув на уведомление о новой задаче, приложение становится в фокусе.

...

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.

RMClient - Remind me to start the timer

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.

Кнопки Save settings и Delete connection позволяют применить внесенные изменения в настройки или отменить их соответственно.

Если данные для подключения были введены верно, после нажатия на Save settings вы попадаете на Основной экран.

Примечание. При нажатии на кнопку Save settings происходит повторное подключение к серверу, что приводит к обновлению списка задач и отключению отсчета времени в Задаче с активным таймером.

Чтобы удалить подключение необходимо нажать Delete Connection. Кнопка Delete Connection не доступна для активного подключения. В период работы  текущем типе соединения Пользователю будут доступны кнопки Save settings и Log out.

Для завершения сеанса подключения необходимо нажать Log out.

 

 

 

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».

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 support@rmclient.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.

Чтобы активировать функцию «Создать новую задачу» в RMClient, вам необходимо установить плагин добавления задачи. После установки плагина автоматически становится доступным создание задач в RMClient.

Если плагин не установлен, появится уведомление с возможностью перехода на информационную страницу с описанием путей решения этой задачи https://rmclient.org/add_issue_plugin.

 

 

To get a license key please:

1. follow the link «Purchase a license» and choose the most suitable pricing;

2. fill in a form;

3. 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.

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

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.

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.

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!

После установки RMClient Вы можете бесплатно в течении 30 дней пользоваться приложением для ознакомления с основными функциями и возможностями.

По окончанию ознакомительного периода отобразится диалоговое окно с сообщением о возможности приобретения лицензионной версии приложения.

 

 

⌘+R/ctrl+R

update task from the remote server Jira or Redmine

⌘+S/CTRL+S

open the Search panel
pressing again closes the panel

+F/ctrl+F

open the Filter panel
pressing again closes the panel

⌘+,/ctrl+,

Open/close Settings screen

Позволяет завершить работу приложения.

Для macOS необходимо нажать комбинацию клавиш CMD+Q.

Для Windows, Linux необходимо нажать комбинацию клавиш Ctrl+Q.

Также, вы сможете завершить работу приложения, нажав на иконку приложения в  tray menu правой клавишей мышки и выбрав из меню опцию Exit.

Если вы попытаетесь завершить работу приложения при наличии Задачи с активным таймером, появиться уведомление, что необходимо остановить таймер задачи, после попробовать снова.

Didn’t find what you were looking for?

E-mail us to discuss and implement your project, application or service. We will answer all of your questions and will offer the best solutions.