Yet Another IM Plugin

Description/Features

The JIRA extension sends issue event notifications and can work as a bot. YAIM supports several IM protocols: XMPP/Jabber, MSN Messenger, Yahoo IM, Skype and can be easily extended to support another one.

Installation

Put jars from distribution package to classpath reachable place (if you use standalone JIRA place jars to JIRA_HOME/atlassian-jira/WEB-INF/lib).

Register new IM account for JIRA YAIM plugin (the account will send notifications and work as bot): e.g. for Yahoo IM go to http://yahoo.com/ and register new Yahoo ID.

Install Listener

You need to install JIRA listener (see http://www.atlassian.com/software/jira/docs/v3.8.1/listeners.html)

Listener class names for protocols:

You can install several listeners, so that you users have choice to select which IM network to use.

Attention Information for Skype Notifier: You need installed Skype client that can login into Skype account on same machine where JIRA installed. YAIM uses your Skype client to communicate to Skype network in same way as Skype Extras. You also may need put Skype4Java JNI connectors to accessible path (if you use standalone JIRA place to JIRA_HOME/temp/ JNIConnector.dll or libJSA.so depending on your OS). Then YAIM Skype Notifier started first time Skype client ask you permission to use Skype: Permit Skype to use YAIM Plugin.

Configure Listener

Standard parameters of IM notifier listeners are IM account login and password, "Enable Bot" and "Notifiable Statuses" parameters, but may vary depending on IM protocol features.

YAIM makes use of User Property Sets to find IM accounts of JIRA users.
You must specify the key of users property holding IM account ID via "Users Jabber/Yahoo/MSN/Skype ID Property" parameter of Listener

Notifiable statuses of users are fully configurable via "Notifiable Statuses" property of listeners. There you can specify notifiable statuses separated by commas or spaces. Available statuses are ONLINE, AWAY, AWAY_LONG, BUSY and OFFLINE.

Usage

Bot Usage

yaim-help - Prints help on specified command
Usage: /yaim-help <Command Name>
Example: /yaim-help comment

view - Prints general information on issue with specified key
Usage: /view <Issue Key>
Example: /view YAIM-1

comment - Comments issue with specified key
Usage: /comment <Issue Key> <Text of the comment>
Example: /comment YAIM-2 Testing comment command on issue YAIM-2

start - Starts progress on issue with specified key
Usage: /start <Issue Key>
Example: /start YAIM-2

stop - Stops progress on issue with specified key
Usage: /stop <Issue Key>
Example: /stop YAIM-2

Known Issues

• IM Bot activated after first event fired
• It's impossible to reconfigure listener without JIRA restart, if listener already instantiated

All these issues are side effects of listener alike implementation of YAIM.