Configuration - Search Attachments

Owned by Artur Karpiński
Last updated: 2017-08-29
2 min read

Basic conifguration

Plugin configuration: Administration > Add-ons > Manage add-ons > Craftware Search Attachments for JIRA > Configure

Default index location
${JIRA Home Directory}/caches/indexes/attachments

Change index location

To change default index location:

  • Open JIRA and go to the plugin configuration page (Administration > Add-ons > Manage add-ons > Craftware Search Attachments for JIRA > Configure)
  • Check field Custom in Path to index directory section
  • Enter correct path in Path field
  • Click Save changes button

To free up disk space you should delete old index directory.

To make changes work you must reindex attachments.

Attachment exclusion

Attachments can be excluded from indexing using 3 kind of rules:

  • File name wildcard e.g. *.jar
  • File size greater than [MB] e.g. 100
  • Project key e.g. DEMO

If more than one rule is added there is logical alternative between them ex. file name matches *.jar or file size is greater than 100 MB

This feature is available in 1.7.0 plugin version or later.

To make changes work you must reindex attachments.

Skipping large files from indexing

If there is not enough memory while indexing files larger than 100MB additional logs can occur in log file:

There is no enough memory to index file={} of size={}, free memory={}

In that case consider extending maximum heap size for your instance by changing jvm -Xmx parameter.


This feature is available in 1.7.0 plugin version or later.

Indexing


The plugin needs an index to work. When you attach files to JIRA issues, they are indexed automatically, but the previously-existing attachments have to be indexed by hand:

  • Open JIRA and go to the plugin configuration page (Administration > Add-ons > Manage add-ons > Craftware Search Attachments for JIRA > Configure)
  • Click Reindex
  • Click Back to configuration;
  • Wait for Indexing in progress message to disappear. If you have many issues and attachments, it can take even a few hours to complete.


Until you'll do full reindex after installation, the plugin may find only some attachments, or even no attachments. You will also see incomplete search results when the reindexing is in progress.