JIRAの小技紹介　クイックサーチのカスタマイズ – リックソフト公式ブログ（Ricksoft Blog）

HOME

2011/12/11
JIRAの小技紹介　クイックサーチのカスタマイズ

Author

樋口晃Akira Higuchi

樋口晃

こんにちは

ショーンさんが困っていたので、JIRA Advent Calendar 2011 に立候補していました。お気軽に立候補してしまったのですが、皆さんの Blog 素敵なので、少々戸惑ってます。　JIRAで謎い黒魔術の Groovyで Validationが出きるなんて自分知りませんでした。今までプラグイン作ってましたので、今後はこれも試してみようと思います。ありがとうございます。

クイックサーチは便利ですが

JIRAを導入すると検索の速さと便利さに皆さん驚きます。クイックサーチ（JIRAの画面右上にある検索小窓です）でキーワードを入力すると関連する情報が検索できるので「これは便利！」と好評です。でも、しばらくすると

要約、説明、コメントでしか検索できないのは不便だ。何とかして！

と言われます。

それは課題ナビゲータを使って下さい。

とお願いしましたが、

いつも使うカスタムフィールドをクイックサーチで検索できるようにして！

~~と無茶な事を言われ~~というご要望を頂きましたので、対応してみました。

お知らせバナーの JavaScriptでカスタマイズ

クイックサーチは html のフォームですから、JavaScriptで修正してしまえばできます。お知らせバナーにこんなHTMLを入れました。

document.getElementById(‘quicksearch’).action=”/private/test_jira//secure/IssueNavigator.jspa?”;
var queryInput = document.getElementById(‘quickSearchInput’);
queryInput.name=queryOption.value;
createHidden(‘reset’, ‘update2’, ”);
}

function createHidden(name, value, id) {
var hidden=document.createElement(“input”);
hidden.type=’hidden’;
hidden.name=name;
hidden.value=value;
if (id != ”) {
hidden.id=id;
}
document.getElementById(‘quicksearch’).appendChild(hidden);
}

function addOption(parent, value, name) {
var option=document.createElement(‘option’);
option.value=value;
option.innerHTML=name;
parent.appendChild(option);
}

function addDropDown() {
var dropDown=document.createElement(“select”);
dropDown.name=’fieldChangeSearch’;
dropDown.id=’fieldChangeSearch’;
document.getElementById(‘quicksearch’).appendChild(dropDown);

addOption(dropDown, ‘normal’, ‘通常検索’);
addOption(dropDown, ‘customfield_10800’, ‘管理番号’);
}

var searchForm=document.getElementById(‘quicksearch’);
searchForm.onsubmit=preSubmit;
addDropDown();
</script>

ポイントを簡単に説明しますとこんな感じです。

画面が表示される時に最後の3行が実行され、
onsubmit イベントに preSubmit が登録される
addDropDown でクイックサーチの下にドロップダウンが表示される。
ドロップダウンは、”通常検索”と”管理番号”の2種類。通常検索が標準のクイックサーチで、管理番号がカスタムフィールド”管理番号”の検索
10800 は、カスタムフィールドのIDです。カスタムフィールドの構成を編集する画面（下記参照）のURLが、というふうに表示される時の最後の数字です。
フォームがサブミットされると、preSubmit関数が起動します。
”通常検索”が選択された場合は何もしません。
”管理番号”が選択された場合は、クイックサーチの入力エリアのフィールド名と値を変更して、検索処理のインプットにします。

できあがりは、こんな感じです。

クイックサーチでカスタムフィールドを選択して検索できるので、お約に立てれば幸です。

検索でヒットしない文字がある

カスタマイズの紹介は以上ですが、JIRAの検索については若干癖が有りますので（通常は問題にならないと思いますが、たまにハマってしまういます）この機会に紹介します。

1文字はヒットしない

JIRAは全文検索のためのインデックスを持っています。日本語の場合、インデックス作成言語にCJKを指定しますが、CJKの場合は2文字ずつインデックスに格納します。このため、1文字はヒットしません。これは同じ検索エンジンを使っているConfluenceも同じです。 “日” や “本” はヒットしませんが、”日本”はヒットします。