redmine_intouch

Plugin is designed by Centos-admin.ru.

Plugin is designed to send notifications to Redmine’s users by Telegram or E-mail.

Requirements

Redmine 3.1.x

This plugin relies on the redmine_sidekiq plugin.

Launch Sidekiq as daemon

• The tools folder has the examples of the plugin config files and the init.d startup script

Plugin Setup

General settings

You should specify all the necessary notification protocols in the "Protocols" section. These are 'telegram' and 'email' available at the moment.

The section "Working days" should contain:

• when the workday starts and when it ends
• what days are considered as workdays

The section "Urgent Tasks" contains the ticket priorities, that will have notifications being sent despite of the time or day of a week.

The plugin contains the fuctionality that allows you send scheduled notifications tagged as "In work" or "Feedback". Specify these statuses in appropriate sections so the plugin could parse them correctly.

Telegram

Specify the Telegram Bot token here.

Creating a Telegram bot

It is necessary to register a bot and get its token. There is a special bot in Telegram for this purpose. It is called @BotFather.

Start it by typing /start to get a list of all available commands. Issue the /newbot command and it will ask you to come up with the name for our new bot. The name must end with "bot" word. On success @BotFather will give you token for your new bot and a link so you could quickly add the bot to contact list. You'll have to invent a new name if the registration fails.

You should enter the token you've just created on the Plugin Settings page.

Bot launch

Specify the following things before launching the bot:

• The Telegram bot token (create a new one as described above if you haven't done it already)
• Working Time - when and what notifications will be sent
• Specify what priorities should be considered as urgent ones
• Specify what statuses should be considered in work and feedback

Run the bot by typing:

bundle exec rake intouch:telegram:bot PID_DIR='/pid/dir'

The tools folder has the examples of the plugin config files and the init.d startup script.

This will add the Telegram users to Redmine and create the Telegram groups in which it was added in Redmine.

Adding a Telegram account to the user

It is also possible to choose the corresponding account for users added with the /start command on the user details page.

If the bot has been changed

If you have changed the bot, then each user needs to greet it personally. One has to connect to the new bot if it has been changed. To do that all the participating Users should find the new bot via search and type the /start command again.

Adding a Telegram Group

The groups are added to Redmine, if the bot was added to them.

The group name is saved on addition. Issue the /rename command in the group chat to change the group name in Redmine.

Settings Templates

The settings templates allow you to set all the required project settings once, and then just choose the right template for each project. Read below of the settings of the plugin integrated into the project.

Regular Notifications Schedule

The plugin is provided with:

• Notification about issues with the "In work" status;
• Notification about issues with the "Feedback" status;
• Notifications about unassigned issues;
• Notifications about overdue issues.

The periodicity of the repeating messages and the recipients settings are configured separately for each project or with templates. The regular notifications schedule is set on the Periodic tasks schedule tab located on the Plugin Settings page.

One has to initialize the periodic tasks before the plugin's first run.

For do this, click "Initialize periodic tasks" in the "Schedule periodic tasks" tab in the plugin settings.

You can also set periodic notifications schedule convenient to you.

Schedule is set using the cron syntax.

Setting the module within the project

Select the Intouch module in the project settings on the "Modules" tab. As a result, the "Intouch" tab in the will appear in Settings.

This tab includes three sections:

• Instant notifications when changing the issue status/priority
• Periodic notifications
• Assigner groups

Instant notifications when changing the issue status/priority

This section lets you set instant notifications for the following recipients:

• Author
• Assigner
• Task watchers
• Telegram groups

**Important note: The Telegram user should issue the /start command to recieve messages.

Periodic notifications

General settings

The intervals of Periodic Notifications for different priority types are specified in General Settings.

In work / Feedback

These tabs contain recipients of the Periodic Notifications with the "In work" and "Feedback" statuses.

Unassigned / Assigned to the group

This tab contains recipients of the Periodic Notifications that are:

• not assigned to anyone
• assigned to the group

Overdue / Without a due date

This tab contains recipients of the Periodic Notifications that are:

• overdue
• with unspecified due date

FAQ

Why bot is not send messages to a group chat?

Perhaps you have not initialized Periodic tasks schedule.

In plugin settings go to the Periodic tasks schedule tab and click Initialize periodic tasks.

Author of the Plugin

The plugin is designed by Centos-admin.ru.