Page Comparison

JEMH

Installation

1. Add

1. the

1. JEMH

1. JAR

1. 
   Get

1. the

1. JAR

1. specific

1. for

1. your

1. version

1. of

1. Jira

1. from

1. the

1. top

1. of

1. the

1. page

1. and

1. copy

1. to

1. the

1. Jira

_

1. WEB-INF/lib

_

1. folder

#

2. Add

1. the

1. ldaputils

1. jar

1. (if

1. you

1. use

1. ldap)

1. 
   Get

1. the

1. latest

1. ldaputils

1. jar

1. (currently

1. 1.0.13)

1. from

1. the

[LDAP

1. LDAP Util

1. library

|CLDAP:LDAP Util library]

1. page,

1. take

1. the

_

1. example-ldaputil.properties

_

1. file

1. from

1. the

1. JAR

1. and

1. rename

1. it

_

1. ldaputil.properties

_

1. ,

1. editing

1. it

1. as

1. appropriate

#

2. Setup

1. Logging

1. (optional)

1. 
   Modify

1. /

1. copy-and-modify

1. the

_

1. WEB-INF/classes/log4j.properties

_

1. ,

1. this

1. will

1. enable

1. logging

1. of

1. all

1. EMH

1. messages

1. to

1. a

1. separate

1. file.

1. Default

1. is

1. DEBUG,

1. other

1. values

1. are

1. 'INFO',

1. 'WARN'

1. and

1. 'ERROR'.

{

1. # # Create a separate appender # log4j.appender.EMHFileLog=org.apache.log4j.RollingFileAppender log4j.appender.EMHFileLog.File=atlassian-jira-emh.log log4j.appender.EMHFileLog.MaxFileSize=20480KB log4j.appender.EMHFileLog.MaxBackupIndex=5 log4j.appender.EMHFileLog.layout=org.apache.log4j.PatternLayout log4j.appender.EMHFileLog.layout.ConversionPattern=%d %t %p [%c{4}] %m%n log4j.appender.EMHFileLog.Threshold=DEBUG # # add entries for the three EMH packages # log4j.logger.com.dolby.atlassian.jira.service.util.handler=DEBUG, EMHFileLog log4j.additivity.com.dolby.atlassian.jira.service.util.handler=false log4j.logger.com.dolby.atlassian.jira.service.util.handler.emh=DEBUG, EMHFileLog log4j.additivity.com.dolby.atlassian.jira.service.util.handler.emh=false log4j.logger.com.dolby.atlassian.jira.service.util.handler.emh.processor=DEBUG, EMHFileLog log4j.additivity.com.dolby.atlassian.jira.service.util.handler.emh.processor=false log4j.logger.com.dolby.atlassian.jira.service.util.handler.emh.service=DEBUG, EMHFileLog log4j.additivity.com.dolby.atlassian.jira.service.util.handler.emh.service=false

Enabling detailed logging of lower level mail operations in Jira is covered in Logging email protocol details.

1. Make Jira aware of the new handler

   Info
   title POP / Imap?
   This example shows how to setup with POP, Imap is equally possible, just not documented, to use Imap, reconfigure Dovecot, and instead of modifying .../pop/popservice.xml

1. modify

1. .../imap/imapservice.xml

1. .

1. Update WEB-INF/classes/services/com/atlassian/jira/service/services/pop/popservice.xml

1. to

1. include:

1. Code Block
   xml xml
   <value> <key>com.dolby.atlassian.jira.service.util.handler.CreateOrCommentHandler</key> <value>Extendable Mail Handler - CreateOrComment</value> </value>

2. Ensure a valid POP Sever is configured
   This is under Global Settings/Mail

1. Servers

1. .

1. If

1. the

1. virtual

1. mailbox

1. approach

1. is

1. used,

1. only

1. one

1. mailbox

1. needs

1. to

1. be

1. setup,

1. in

1. the

1. example

1. shared@jira.myco.net

1. :
   Image Added
2. Configure the handler
   Modifiy the two properties files. when done, they should be copied to WEB-INF/classes:

1. 
   If you use ldap,

1. the

1. minimum

1. config

1. required

1. is

1. to

1. identify

1. a

1. valid

1. user

1. which

1. is

1. used

1. to

1. validate

1. ldap

1. connections.

1. If

1. not,

1. you

1. don't

1. need

1. this

1. file.

1. 
   The EMH config file is just an extension of the properties that a mail handler is given, anything you could put in the Jira UI, you can equally add here. Look at the settings, understand what they do, make changes as appropriate for your needs.
   The contents of the configuration file changes as new features are added and refinements are made, check the 'example-emh.properties'

1. available

1. inside

1. every

1. JAR.

Some

example

properties

are:

projectAutoAssign=true, issuetype=3, configFile=emh.properties
{noformat}
*

Service

Properties:
Image Added
Service listing after save:
Image Added

1. Restart Jira

JEMH Handler Configuration File

The following sections describe the fields that can be used to configure JEMH. Organised by where they are used, in future I will try to expand on the documentation and provide more detailed examples.
as of 0.7, all 'default' fields are prefixed with default, eg defaultPriority etc. for clarity.
An example configuration file is packaged in every JAR, called 'example-emh.properties',

contrast

this

file

to

your

local

file

for

changes.

CommentHandler

AbstractFieldProcessor

JEMH Poker Installation

Image AddedImage Added

This JEMH Poker is a simple javaapplication that triggers the JEMH to do an immediate mail retrieval. The current 1.0 release of the JEMH Poker contains a simple file monitor, suitable for most Unix or Linux platforms and associated file-based mail systems. Exchange is an unknown quantity, as Microsoft products are not known for their openness - the approach I took in my organization was to use Exchange purely as a vehicle to get mail to where I could do something useful with it (see setting up Postfix smtp server and Dovecot POP server pages here).

Installation of the remote agent

1. Extract the tgz in /usr/local

   No Format
   cd /usr/local tar xzf filename.tgz

2. Make the launch shell script executable

   No Format
   cd jemh-mail-notifier-...... chmod +x

1. *.sh

2. Link a common name to the current version

   No Format
   ln -s jemh-mail-notifier-...... jemh-mail-notifier

2. Ensure you have Java in your path, the following should give some version information. If not, install Java 1.5+

1. or

1. modify

1. the

1. script

1. (you

1. should

1. know

1. what

1. to

1. do)

1. No Format

1. java

1. -version

2. Edit the configuration file emh-poker.properties

1. ,

1. set

1. the

1. server

1. (IP

1. address

1. or

1. DNS

1. name)

1. and

1. the

1. port

1. (default

1. is

1. 7777).

2. Run

1. the

1. script

1. as

1. the

1. appropriate

1. user

1. for

1. your

1. environemnt.

1. With

1. Postfix,

1. you

1. may

1. need

1. to

1. be

1. running

1. as

1. Postfix.

1. Running

1. as

1. root

1. is

1. to

1. be

1. avoided,

1. create

1. a

1. service

1. user

1. as

1. follows:

1. No Format

1. root@server:/usr/local/jemh-mail-notifier-1.1-SNAPSHOT# adduser --disabled-login --no-create-home -ingroup postfix jirapoker Adding user `jirapoker' ... Adding new user `jirapoker' (1009) with group `postfix' ... Not creating home directory `/home/jirapoker'. Changing the user information for jirapoker Enter the new value, or press ENTER for the default Full Name []: Room Number []: Work Phone []: Home Phone []: Other []: Is the information correct? [Y/n] Y

Create a SysV startup script in /etc/init.d

Create

it

as

'jemh-mail-notifier'

{

}

No Format
#! /bin/sh ### BEGIN INIT INFO # Provides: jemh-mail-notifier # Required-Start: # Required-Stop: # Default-Start: 2 # Default-Stop: # Short-Description: Monitors a mailbox and poke jira when mail arrives ### END INIT INFO PATH=/sbin:/bin . /lib/lsb/init-functions case "$1" in start) cd /usr/local/jemh-mail-notifier ./run.sh & ;; stop) # No-op echo Cant stop it from here, use 'ps -ef | grep java' at the prompt ;; *) echo "Usage: $0 start" >&2 exit 3 ;; esac {noformat}

To

make

the

service

start

at

bootup:

{

}

No Format
sudo apt-get install sysvconfig sysvconfig {noformat}

Now

find

the

jemh-mail-notifer

and

enable

for

startup,

click

finish

to

save.

h3.

Installing

the

Jira

JEMH

Poker

Service

The

main

JEMH

includes

everything

necessary,

the

only

thing

that's

required

is

a

bit

of

configuration:

#

1. Login

1. to

1. Jira

1. as

1. admin

#

2. Go

1. to

1. the

1. Services

1. screen

#

2. Add

1. a

1. service:

|| Name | JEMH Poker Service | || Class |

1. Name	JEMH Poker Service
   Class	com.dolby.atlassian.jira.service.util.handler.emh.service.EMHPokerService

| || Delay | 1 _

1. Delay	1 note:

1. this

1. is

1. essentially

1. the

1. delay

1. in

1. initial

1. startup

1. as

1. Jira

starts_ | # Select the default port options or change as you see fit (must fix Poker configuration, above) After configuring you should see something like: !poker-service.png! h3. Poker Sequence Diagram {gliffy:name=JEMH Poker - remote agent|space=Jira Extendable Mail Handler|page=Installation and Configuration|pageid=2752853|align=left|size=L}

1. starts

2. Select the default port options or change as you see fit (must fix Poker configuration, above)

After configuring you should see something like:
Image Added

Poker Sequence Diagram