Jira

  

This extension contains functions for embeding bug information from Jira bug tracker  Related Links: Extension Overview, DekiScript Overview, Extension Demos.

Assembly: mindtouch.deki.services
SID: http://services.mindtouch.com/deki/draft/2008/02/jira

This service requires Deki Wiki 1.9.0 or later.

To enable this extension, follow these steps:

  1. Go to Service management in the Control Panel of your wiki.
  2. Under Add Service, click on Local, and select type Extension.
  3. Enter a description and the extension SID: http://services.mindtouch.com/deki/draft/2008/02/jira
  4. Add any additional configuration settings that are required by the extension (see below).
  5. Click on add service.

Configuration:

Before the Jira service can be used, it must be configured.

Config Key Description
jira-uri URI to your jira installation. This URI + /rpc/soap/jirasoapservice-v2 needs to exist. Be sure that the RPC + SOAP plugin is enabled.
username A Jira username that has view access to your projects of interest
password Password for the Jira account

Functions:

  1. jira.link
  2. jira.table
  3. jira.tablesearch
  4. jira.count

jira.link(id : num) : xml

Embed a link to a Jira bug report. A summary of the bug is shown when hovering over the link. The link is crossed out when the bug is closed or resolved.

Parameters:

Name Type Description
id int The bug number to link to

Samples:

   Output

A link to bug# 2084

{{ jira.link(2084) }} 
closed bug.PNG

  


jira.table(filter : str) : xml

Create a table listing of bugs from a given predefined filter

Parameters:

Name Type Description
filter string filter name

Samples:

   Output

Bugs returned by the 'SVN Module tickets'

 {{ jira.table("SVN Module tickets") }}
jira table.PNG

  


jira.tablesearch(filter : str) : xml

Create a table listing of bugs from a full text search

Parameters:

Name Type Description
query string Search query

Samples:

   Output

Bugs returned by the search terms 'exception'

 {{ jira.tablesearch("exception") }}
jira table.PNG

jira.count(filter : str) : num

Get the number of bugs returned by a filter

Parameters:

Name Type Description
filter string filter name


Samples:

   Output

Number of bugs returned from the 'SVN Module tickets' filter

 {{ jira.count("SVN Module tickets") }}
101

  

Known issues

Bug#SummaryStatusOpened ByAssigned ToSeverity

Development log

RevisionDateAuthorMessage
r103899/2/2008 8:33:44 PMmaximmDeki API - JiraService

* Prefixed Jira with Atlassian
r99368/12/2008 8:02:23 PMmaximmDeki Service - Jira

* If a filter name isn't found, the list is refetched while bypassing the cache

BUGFIX 4722: Jira Extension fails to find new filters

BUGFIX 4621: Jira extenion functions that use a filter do not work
r97488/1/2008 10:41:58 PMstevebDeki (trunk):

DekiServices:

* updated service-type in service blueprint (passive attribute that's not yet used anyway)
r97277/31/2008 7:11:51 PMstevebDeki (trunk):

Services/Scripts`:

* iframe.xml: new script added

* updated all services/scripts to point their help URI to wiki.developer.mindtouch.com (instead of opengarden)
r88205/31/2008 4:07:18 PMstevebDeki Wiki (trunk):

* redist: updated redistributable files

* misc:

* updated all occurrences of 'MindTouch Deki Wiki' to 'MindTouch Deki'

* extended all copyright notices to 2008
r87635/29/2008 6:06:42 PMstevebDeki Wiki (trunk):

* misc: removed an extra space from the default copyright notice

Tools:

* DekiExt.php: added 'protocol' attribute to <uri> element

* GoogleAppEngine: added sample application
r84895/9/2008 6:38:11 PMmaximmDeki Jira Service

* Added service config setting: jira-session-timeout-mins to force refreshing of session token after given length of time. (default 30)

BUGFIX 3615: Jira extension: time out error about 60 minutes after initial use
r81924/21/2008 5:13:40 AMstevebDekiWiki (trunk):

* updated DekiScript binary

* MISC: updated all relevant SIDs to new shorter format (e.g. sid://mindtouch.com/2006/11/dekiwiki) (NOTE: old SIDS are preserved for backwards compatibility)

* DekiXmlParser: evaluate attributes which have their value enclosed in double-curly braces
r76883/14/2008 8:37:52 PMmaximmDeki JiraService MantisService SubversionService TracService

* Updated div css classes
r74962/29/2008 12:44:35 AMmaximmDeki Extensions

Trac, Jira, Mantis, Subversion:

* Added links to documentation
r74952/29/2008 12:36:40 AMmaximmDeki Extensions: Jira, Mantis, Trac

Jira:

* Fixed jira.count to return a plain integer

Trac

* Fixed trac.count to return a plain integer

Mantis:

* Added mantis.count

* Added CSS styling and fixed tags

* Fixed duplicate bug listing issue (starting at page 1 instead of 0)

* Defaulted to top 20 bugs which is same as a batch size
r74422/27/2008 1:55:55 AMmaximmadded missing file

Tag page
Viewing 4 of 4 comments: view all
I've managed to set up the configuration as you've stated but I keep getting an error. Here is what I get when I try to use jira.tablesearch

Function 'jira.tablesearch' failed with response
Error: NameResolutionFailure

Any ideas?
Thanks.
Posted 04:57, 16 Mar 2008
If you have issues with timeouts to your jira server, you can do the following:

Another work around. This is for all of you like me who have to keep your timeout. You can add an api call to crontab to refresh every 30 minutes to refresh the service via curl, as follows:

00,30 * * * * root curl -d @{Jira Service ID}.xml -H "Content-type: text/xml" --cookie authtoken="{Token ID}" http://{Wiki Address}/@api/deki/site/services/{Jira Service ID}

You can find your jira service id by typing "http://{Wiki Address}/@api/deki/site/services" in your browser, obviously replacing {Wiki Address} with your server address and look for Jira.

You can find your "{Token ID}" by looking at your cookies. There is a cookie called authtoken and you can use the id in that to authenticate.
Posted 16:45, 21 Mar 2008
Where do I put the Config keys ? where I configure the service ? or in the Configuration page ?
Posted 15:45, 3 Apr 2008
reisw: you probably need to add an entry into your hosts file on the dekiwiki VM (I assume this is what you are running) for the jira you are accessing

Try pinging the jira server using the name. If it can't find it, this is most likely your issuse.
Posted 16:40, 22 May 2008
Viewing 4 of 4 comments: view all
You must login to post a comment.
Powered by MindTouch Deki v.8.08