Помощь

RMClient — это приложение, созданное для учета рабочего времени в системе управления проектами Jira и Redmine.

После установки RMClient необходимо ввести два обязательных параметра:
Server URL (путь к вашему серверу Redmine, например, http://someredmine.com) и API Key (ключ для авторизации в вашем Redmine).

RMClient - Окно входа

Ознакомительная версия позволяет работать с программой на протяжении 30 дней. Для продолжения работы программы необходимо приобрести лицензию.

RMClient - Trial period expired

Для установки RMClient на платформе Windows необходимо:

  1. Запустите файл установки RMClient. exe;
  2. Нажмите на кнопку Установить;
  3. Подтвердите установку с параметрами по умолчанию или введите собственные;
  4. После успешной установки RMClient запускается автоматически.

Windows 7 и более поздние версии поддерживаются.
Более старые операционные системы не поддерживаются (и не работают).

Для установки RMClient на платформу Mac OS необходимо:

  1. Запустите файл установки RMClient.dmg, а затем Install RMClient;
  2. Если отобразилось окно предупреждения, что файл скачан из интернета, нажмите на кнопку Открыть (Open);
  3. Подтвердите установку с параметрами по умолчанию или введите собственные и нажмите на кнопку Continue;
  4. Если потребуется, введите Login и Password пользователя Mac OS для подтверждения установки;
  5. После успешной установки RMClient запускается автоматически.

Минимальная поддерживаемая версия для macOS - macOS 10.10 (Yosemite).
Более старые операционные системы не поддерживаются (и не работают).

Для установки RMClient на платформе Linux необходимо:

  1. Запустите файл установки RMClient. deb или appimage;
  2. Нажмите на кнопку Установить;
  3. Подтвердите установку с параметрами по умолчанию или введите собственные;
  4. После успешной установки RMClient запускается автоматически.

RMClient гарантированно работает только в Ubuntu 12.04, но также могут быть проверены следующие платформы:

  • Ubuntu 12.04 и новее
  • Fedora 21
  • Debian 8

О выходе новой версии RMClient мы сообщаем нашим клиентам в рассылках и постах на странице www.facebook.com/rmclient. Обновление доступно как клиентам с оплаченной лицензией, так и во время использования 30-дневной бесплатной версии.

После выхода новой версии, RMClient в Настройках предложит загрузить и установить новую версию.
В отображаемом уведомлении будет показана Установленная версия клиента и Версия обновления, а также краткая информация об изменениях в данной версии.

Чтобы установить обновление необходимо:

  • в появившемся окне при запуске RMClient нажать на кнопку «Загрузить сейчас»;
  • после окончания загрузки можно нажать на кнопку «Установить» и немедленно обновить приложение, либо выбрать обновление после перезагрузки приложения.

При немедленном обновлении работающий клиент будет автоматически закрыт и обновлен.

Во время обновления все данные, введенные в окне Settings, сохраняются.

Процесс обновления аналогичен для всех поддерживаемых платформ.

После подключения RMClient к серверу Redmine, будет отображен основной экран.

Элементы основного экрана:

RMClient - основной экран

В левой части верхней панели отображается Имя пользователя. Кликнув на него, Вы попадаете в личный кабинет в Redmine.

Фильтр позволяет выбрать отображаемые задачи по следующим критериям:

  • Project — список названий проектов с задачами, назначенными на Вас.
  • Tracker — список трекеров.
  • Status — список статусов.
  • Priority — список приоритетов.
  • Version — список версий.

Для того чтобы применить фильтр, выберите необходимую комбинацию полей и нажмите Apply.
Для того чтобы сбросить фильтр, нажмите Reset.

Выбор разных параметров поможет быстрее найти нужные задачи. Например, с помощью поля Status Вы можете выбрать все Новые задачи, а затем отфильтровать «важные» в поле Priority.

Примечание. Выбор полей взаимосвязан. Выбирая определенный Проект, другие поля будут отображать все варианты, но активными будут только те, которые есть у задач выбранного проекта. Эта схема работает со всеми полями фильтра.

RMClient - Использование фильтраRMClient - Отфильтрованные задачи

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

После ввода первого символа задачи отфильтруются. Попадающие под критерий поиска будут активными, так же как и запущенная в данный момент задача, остальные «затемнятся». Если с критерием поиска на экране нет совпадений, отобразится Not found.

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

RMClient - ПоискRMClient - Результат поиска

Данная кнопка позволяет немедленно синхронизировать клиент с Вашим сервером Redmine.

RMClient - Обновить

Кнопка, ведущая на Экран настроек.

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

В Задаче отображается:

  • Название задачи,
  • Приоритет,
  • id задачи в Redmine,
  • Название проекта,
  • Первые строки Описания задачи,
  • Время, затраченное на текущий момент,
  • Оценка времени реализации.

Название задачи является ссылкой на задачу в Redmine. Приоритет, id задачи в Redmine и Название проекта являются ссылкой на задачи проекта в Redmine.

При наведении мышки на Задачу, появляются иконки Избранное, Редактировать и Старт.

Нажав на кнопку Избранное, задача прикрепляется к началу списка задач.

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

Отображение поля Оценка времени реализации можно отключить в Настройках.

После запуска Задачи ее цвет меняется на красный и она перемещается на первую позицию в Списке задач. Перед Названием задачи появляется Отсчет времени затраченного на Задачу, а после строк Описания задачи — дополнительные поля: Активность и Статус. Это позволяет поменять статус на соответствующий этапу работы.

Вместо иконки Старт отображается иконка Пауза, нажатие на которую останавливает отсчет времени в Задаче.

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

Нажав на кнопку «Избранное», задача будет прикреплена к верху списка. Это позволит быстрее находить важные или часто используемые задачи.

Main-screen - ИзбранноеMain-screen - Избранное - убрать из избранного

С помощью данного окна вы можете изменить Статус задачи, оставить Комментарий к задаче, изменить прочие параметры, а также перевести ее на другого пользователя без необходимости заходить в веб версию Redmine.

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

В окне редактирования отображается:

  • представление Задачи (отображает информацию, аналогичную выводимой в Списке задач);
  • стандартные поля для задачи: Status, Priority, Assignee, Start date, Due date, Estimated time, Done, Version;
  • дополнительные поля (в зависимости от настроек вашего Redmine);
  • поле для ввода Комментария к задаче;
  • добавление файлов к задаче (Attach files (Beta)).

Для добавления файлов к задаче необходимо нажать на кнопку Attach files (Beta), выбрать нужный файл, заполнить его название и нажать на кнопку Submit. По умолчанию ограничение размера каждого файла 97.7MB. Максимальный размер файла зависит от настроек сервера. Функция находится в стадии Beta, абсолютная работоспособность не гарантируется.

Для сохранения изменения в полях необходимо нажать на кнопку Submit. Если какое-либо поле с обязательным заполнением окажется пустым, будет показана ошибка. Исправьте ее и повторно нажмите Submit.

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

RMClient - Редактирование задачи

Чтобы оставить комментарий к задаче необходимо:

  • нажать на иконку Редактировать;
  • написать текст комментария в поле Notes;
  • нажать на кнопку Submit.

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

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

RMClient - СтатусRMClient - Деятельность

Окно настроек позволяет изменить состояние настраиваемых функций и вспомогательных полей RMClient. Для изменения параметров соединения с сервером Redmine или Лицензионного ключа используются поля: Server URL, API Key, License Key. Для сохранения внесенных изменений необходимо нажать на кнопку Sign in.

RMClient - Окно настроек

Server URL — это путь к вашему серверу Redmine, например someredmine.com или redmine.somesite.com.

 

API Key доступен на странице настроек Вашего аккаунта в Redmine (http://someredmine.com/my/account). Справа на странице в блоке «Моя учётная запись» есть раздел «Ключ доступа к API», нажмите ссылку «показать». Если Вы не нашли заголовок «Ключ доступа к API» на странице настроек, Вам необходимо включить «Веб-сервис REST».

RMClient - Redmine API access key

Включить веб-сервис REST может администратор Redmine. Для этого необходимо открыть страницу Настройки/Аутентификация (http://someredmine.com/settings?tab=authentication), отметить функцию «Включить веб-сервис REST» и сохранить настройки.

License Key (лицензионный ключ) позволяет использовать RMClient после ознакомительного периода. Получить лицензию прямо сейчас.

Данный параметр активирует логирование технической информации, которая поможет нам в устранении проблем с работой или настройкой RMClient. По умолчанию активно.

Активирует функцию pop-up уведомлений при получении новых задач. Отображаются в правом нижнем углу экрана.
По умолчанию активно.

RMClient - New task

Активирует отображение Оценки времени реализации задачи. Выводится под значением уже затраченного времени в списке задач. По достижению оценочного значения, отобразится pop-up уведомление с предупреждением. По умолчанию неактивно.

Popup - предупреждение о достижении оценочного времени

Активирует функцию pop-up уведомления при неактивности пользователя более 5 минут. Pop-up содержит таймер, который считает время бездействия от момента появления, а также список задач и фильтр по нему. После возвращения к рабочему месту, пользователь может добавить время неактивности к нужной задаче, либо сбросить насчитанное время бездействия. По умолчанию неактивно.
Данная функция некорретно работает для пользователей Linux через Wine.

RMClient - No activity

Активирует вывод pop-up с подтверждением при выходе из приложения. По умолчанию активно.

После остановки таймера активирует вывод pop-up с полем для комментария к затраченному времени на выполнение задачи. По умолчанию активно.

Активирует загрузку всех задач, которые доступны для текущего пользователя. По умолчанию неактивно. Активируется комбинацией клавиш cmd+2/ctrl+2

Активирует загрузку всех задач, в которых текущей пользователь является наблюдателем. По умолчанию неактивно. Активируется комбинацией клавиш cmd+3/ctrl+3

Активирует загрузку всех задач, которые доступны для текущего пользователя, но не назначены ему. По умолчанию неактивно. Активируется комбинацией клавиш cmd+4/ctrl+4

Активирует вывод напоминания, что таймер не запущен. Уведомление появится спустя время, которое вы указали в поле Remind me to start the timer.

Интервал времени, спустя которое появится напоминание запустить отсчет времени в задаче. Минимальное значение 5 минут.

RMClient - Remind me to start the timer

Позволяет установить частоту синхронизации с сервером для получения новых задач. Минимальный интервал 60 секунд.

Позволяет установить частоту синхронизации с сервером для записи времени по текущей задаче в базу. Минимальный интервал 60 секунд.

Данные кнопки позволяют Применить внесенные изменения в настройки или отменить их соответственно. Если данные для подключения были введены верно, после нажатия на любую из кнопок вы попадаете на Основной экран.

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

Вам необходимо установить последнюю версию Adobe AIR. Ее можно скачать здесь.

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

Вам необходимо проверить, есть ли в настройках вашей учетной записи разрешение на запись, просмотр и редактирование времени, затраченного на проект. Для этого в настройках проекта нужно выбрать вкладку «Участники» и посмотреть, какая роль назначена выбранному пользователю.

Проверить наличие прав у роли можно, если у Вас есть доступ к администрированию Redmine. Во вкладке «Администрирование» выбираете пункт «Роли», и там можно редактировать все ее права, в том числе и права учета времени.

Если Вы используете язык отличный от английского, то вы можете переключить шрифт на стандартный Arial. Для этого переведите чек-бокс «Use standard font» в активное положение.

Возможно, у Вас в настройках Redmine поле «Деятельность» выбрано обязательным для заполнения. Чтобы убрать это ограничение, нужно зайти на адрес_Redmine/enumerations/ и выбрать какой-либо вид активности действительным по умолчанию.

Если у Вас не получается решить возникшую проблему, то Вы можете включить логирование в настройках клиента, поставив галочку в чек-боксе «Log». Теперь все Ваши действия будут записываться в текстовый файл, который можно найти в папке «Мои документы» — «RM-клиент». Отправьте нам лог с проблемой на адрес support@rmclient.org, и мы поможем разобраться.

В случае потери соединения с сервером производятся попытки автоматического соединения, но при этом отобразится всплывающее окно с предупреждением. Нажатие на кнопку «Try again» проводит повторное соединение с сервером и после восстановления связи, записывает насчитанное время в базу данных Redmine. При нажатии на кнопку «Cancel» время не будет учтено.

Для получения лицензионного ключа необходимо перейти по ссылке «Купить Лицензионный ключ» и выбрать удобный тариф. Заполнить форму. Произвести оплату любым удобным для Вас способом: Кредитная/дебетная карта, PayPal и прочее.

После подтверждения платежа, Вы получаете License Key, который необходимо ввести в соответствующее поле в RMClient.

License Key (лицензионный ключ) позволяет использовать RMClient после ознакомительного периода. Получить лицензию прямо сейчас.

При покупке лицензии, Вы можете выбрать наиболее выгодный для Вас тариф. При покупке 10 — 20 или 21 — 50 лицензий Вы получаете скидку 10% или 20% соответственно. Детальнее на странице тарифов.

Вам необходимо отправить сообщение на support@rmclient.com или заполнить форму обратной связи.

В сообщении необходимо указать идентификационный номер вашего заказа (Order ID), чтобы мы могли оказать эффективную и быструю поддержку.

Мы регулярно проводим промо-акции и раздачу промо-кодов. Подписывайтесь на нашу страницу в www.facebook.com/RMClient или рассылку новостей и не пропустите выгодное предложение!

⌘+R/ctrl+R

обновить список задач с удаленного сервера Jira или Redmine

⌘+S/CTRL+S

открыть панель Поиска
повторное нажатие закрывает панель

⌘+F/CTRL+F

открыть панель Фильтров
повторное нажатие закрывает панель

⌘+,/ctrl+,

Открыть/закрыть Настройки