Overview

DocMiner allows users to view documents on JIRA and embed issues related to texts and images regardless the document format and the platform:


Major features

  • DocMiner provides full bi-directional traceability between JIRA issues and document contents. 
  • It transforms static document contents into social contents by enhancing user collaboration around documents.
  • It tracks document versions and provides an impact of changes on JIRA issues.
  • The document repositories are fully integrated allowing users to access to documents easily from within JIRA.
  • It is a very flexible solution: it can be used as document review, document analysis tool, share and publish documents, etc.
  • It supports a wide range of document formats and devices.
  • It allows users to track document contents from their workplaces or in the go.

Video

This 1' 30' video shows DocMiner running integrated with the JIRA web UI.

Documentation (on Google Docs)


Installation

  
  • [Optional] Mobile clients for iOS and Android devices and tablets:
  • [Optional] Desktop Client for Windows (unzip) and Mac OS X (requires Adobe AIR) (v.2.5.6 2013-04-06)

How it works

The whole of the application is hosted on the DocMiner Server and embedded in JIRA through the plug-in. Hence, the plugin must be configured on JIRA to point to the DocMiner Server. The plug-in only invokes the DocMiner server with few parameters about the running context (user, project and issue). The DocMiner Server provides several clients to explore document repositories (Subversion or SharePoint). Those document repositories must be registered on the DocMiner Server as well the JIRA instance. An Installation Wizard allows to input all the data required in order to configure the DocMiner server in a painless way.

Once an user explores a repository and selects a document link, the DocMiner Server transforms it into the PDF format by using LibreOffice and later into the the Adobe's SWF format by using the SWFTools program and displays it on JIRA by using the built-in document viewer. A two level cache is implemented in order to transform documents only once at the server side and to store locally the document in the user device at the client side. This allows users to work with documents in a really efficient way in terms of performance and hardware and network resources saving.


The built-in document viewer allows users to embed JIRA issues in documents and relate them to text paragraphs and images. The DocMiner Server stores the relationships between JIRA issues and text coordinates in an Apache Derby Java database. Thus, DocMiner searches for the latest document version related to an issue and shows the issue besides the related text paragraph every time that an user opens an issue, providing an unprecedented traceability between document CONTENTS and JIRA issues.

Supported document formats

A wide variety of document formats are supported:
  • MS Office (Word, Excel, PowerPoint) - any version
  • Adobe Portable Document Format (PDF)
  • Open Document Format (ODF) - LibreOffice and OpenOffice
  • Many more...

Supported document repositories

Documents must be stored on 
  • Apache Subversion (WebDAV) or 
  • Microsoft SharePoint (document library)
IMPORTANT: It does not work with JIRA attachaments. 
Frequent Asked Question: Why DocMiner does not support JIRA attachments as document repository? Answer: Because JIRA does not support versions for attachments. Hence, if a new version is uploaded there is no way to know it and the issues might be related to random positions on the new version as text coordinates could change.

Supported OS

  • Windows
  • Mac OS
  • Linux
  • iOS
  • Android

Supported desktop browsers

  • Internet Explorer
  • Safari
  • Firefox
  • Chrome

Other requirements

  • JIRA 5.0 or above
  • Flash Player 11.1 or above