Scripting Samples

Introduction

Jira Scripting Suite allows you to execute custom Jython script to evaluate workflow conditions, perform validations and post functions. Script is evaluated in the context, which differs for each type of script (see sections below for details).

Jython is a Python port to Java, visit http://www.python.org/doc/2.5/ for general info.

Be Careful

Be careful when using single script file in many workflow actions - when you change this script in one action, all other will also be affected!

Conditions

Context:

Variable	Description
result	Result of condition evaluation; boolean value, default is True
issue	Issue object
log	org.apache.log4j.Logger
transientVars	A map containing all context data passed to validator

The main context variable here is result. Validator expects it to contain boolean value - True or False.

result = True # this workflow action is enabled
result = False # and now it's disabled for everyone

You can get any attribute of the Issue object using its Java methods. For example, let's deny the action for all issues having word TEST in Summary:

summary = issue.getSummary() # note that summary is a python string, not Java String
result = summary.find('TEST') < 0 # find() returns -1 if string not found

# or simply in one string
result = issue.getSummary().find('TEST') < 0

Be Careful

Although issue is actually a MutableIssue object, you can not change any issue data in condition script.

Validation

Context:

Variable	Description
result	Result of validation; boolean value, default is True
invalid_fields	PyDictionary(), empty map by default
description	PyUnicode(), empty unicode string by default
originalIssue	Original (unmodified) Issueobject
issue	Modified Issueobject
log	org.apache.log4j.Logger
transientVars	A map containing all context data passed to validator

In validation script we use another two valiables along with result to reports an error to the user: invalid_fields and _description _. See example:

result = False
description = 'General error description'
invalid_fields['summary'] = u'Error description for the Summary field'

This script produces such a message for every issue with that workflow:

invalid_fields is initially an empty map. You can attach error messages both to standard and custom fields. In case of custom field you should use its ID like this:

result = False
invalid_fields['customfield_10010'] = u'This custom field is invalid!'

Post Functions

<TODO>

Code Snippets

Sending a Custom E-mail Notifier

sender = 'sender@somedomain.com'
to = 'recipient@somedomain.com'
subj = "SUBJECT"
body = "MESSAGE BODY"

server = 'smtp.somedomain.com'

from email.MIMEText import MIMEText
msg = MIMEText(body, 'plain', 'utf-8')
msg['Subject'] = subj
msg['To'] = to
msg['Importance'] = 'high'

import smtplib
s = smtplib.SMTP(server)

s.sendmail(sender, [to], msg.as_string())
s.quit()

More Complicated E-mail Notifier

Thanks to Jared Meeker for this code

# -*- coding: UTF-8 -*-

#import inspect

# Issue Details
key = issue.getKey()
status = issue.getStatusObject().name
summary = issue.getSummary()
project = issue.getProjectObject().name
resolution = issue.getResolutionObject().name
description = issue.getString("description")

# Get Requestor custom field (text, not user picker)
import com.atlassian.jira.ComponentManager
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.issue.fields.CustomField
customFieldManager = ComponentManager.getInstance().getCustomFieldManager()
customField = customFieldManager.getCustomFieldObjectByName("Requestor")
requestor = issue.getCustomFieldValue(customField)

# Verify that we have an email address in the text field
import re
if (re.match('[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,4}',requestor)):
       # Get posted comment if it exists
       try:
               comment = dict(transientVars)['comment']
       except:
               trash = ''


       # Email Details
       sender = '*******@*************.***'
       to = requestor
       subject = '[JIRA] ' + status + ': (' + key + ') ' + summary

       # Build the body of the email
       body = ''
       if (status == "Closed"):
               body = body + "\r\nAccording to our records, your issue (" + key + ") has been resolved.\r\n\r\n"
       if (resolution == "Won't Fix"):
               body = body + "\r\nThis issue will not be fixed. A description of why should be below.\r\n"
       elif (resolution == "Duplicate"):
               body = body + "\r\nThis issue is a duplicate of another issue.\r\n"
       elif (resolution == "Incomplete"):
               body = body + "\r\nThis issue has been marked as incomplete. A description of why should be below.\r\n"
       elif (resolution == "Cannot Reproduce"):
               body = body + "\r\nThe developers have been unable to reproduce the error you describe.\r\n"
       elif (resolution == "Rejected"):
               body = body + "\r\nThis issue has been rejected. A description of why should be below.\r\n"
       body = body + "\r\n"
       try:
               body = body + "Comment:\r\n" + comment + "\r\n"
       except:
               body = body + "Comment:\r\nNo comment was entered\r\n"
       body = body + "\r\n"
       body = body + "> " + summary + "\r\n"

       barline = '>'
       while (len(barline) <= len(summary)+2): barline = barline + "-"

       body = body + barline + """
       >
       >
       >          Key: """ + key + """
       >      Project: """ + project + """
       >
       """ + description + """

       --
       This message is automatically generated by JIRA.
       -
               If you think it was sent incorrectly contact one of the administrators: https://jira.somedomain.com:8443/secure/Administrators.jspa
       -
       For more information on JIRA, see: http://www.atlassian.com/software/jira"""


       # Build mail message
       from email.MIMEText import MIMEText
       msg = MIMEText(body, 'plain', 'utf-8')
       msg['Subject'] = subject
       msg['To'] = to
       #msg['Importance'] = 'high'

       # Send the email
       import smtplib
       s = smtplib.SMTP('*****.*******.***') # ip or domain name of smtp server
       s.sendmail(sender, [to], msg.as_string())
       s.quit()

Child pages

Introduction

Conditions

Validation

Post Functions

Code Snippets

Sending a Custom E-mail Notifier

More Complicated E-mail Notifier

230 Comments

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (darkoc)

Unknown User (tkrug0210)

Unknown User (darkoc)

Unknown User (tkrug0210)

Unknown User (darkoc)

Unknown User (wufei)

Unknown User (brian)

Unknown User (keith.lee)

Unknown User (darkoc)

Unknown User (chrome@stupendous.net)

Unknown User (chrome@stupendous.net)

Unknown User (jira.support@ubisoft.com)

Unknown User (stenech)

Unknown User (stenech)

Unknown User (kubo@solvere.sk)

Unknown User (kubo@solvere.sk)

Unknown User (matt.bates)

Unknown User (hmenzi)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (hmenzi)

Unknown User (muhammad_rahman@cable.comcast.com)

Unknown User (brian)

Unknown User (muhammad_rahman@cable.comcast.com)

Unknown User (lhawkes)

Unknown User (mahku)

Unknown User (mahku)

Unknown User (mahku)

Unknown User (mahku)

Unknown User (mahku)

Unknown User (sunderhill)

Unknown User (gopherr)

Unknown User (ohingardail)

Unknown User (ohingardail)

Unknown User (brian)

Unknown User (hmenzi)

Unknown User (mahku)

Unknown User (hmenzi)

Unknown User (kewwordtest)

Unknown User (kewwordtest)

Unknown User (daregazi)

Unknown User (daregazi)

Unknown User (xerocube)

Unknown User (hmenzi)

Unknown User (hmenzi)

Unknown User (brian)

Unknown User (dariam)

Unknown User (e.kubascikova@corag.sk)

Unknown User (brian)

Unknown User (hmenzi)

Unknown User (wufei)

Unknown User (wufei)

Unknown User (wufei)

Unknown User (wufei)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (tkrug0210)

Unknown User (justforthee)

Unknown User (gturner)

Unknown User (niki89g)

Unknown User (hitthedrum)

Unknown User (toini)

Unknown User (gisela.sn)

Unknown User (dan.sexton)

Unknown User (robert)