サービス
サービスは、Jira 内で定期的に実行されるクラスです。サービスは Jira 内で実行されるため、すべての Jira API を使用できます。また、Java で記述されているため、任意の Java ライブラリを使用できます。
サービスの利便性として、データを Jira に定期的にプルすることにより、外部システムとの統合が可能になります。Jira には事前に作成済みのサービスがいくつか付属していますが、カスタム サービスを作成して、実行中に接続することもできます。
新しいサービスを作成しませんか?
組み込みの Jira サービスを拡張しない場合、SAL API を使用しサービスを新しく記述することをおすすめします。詳細については、「SAL チュートリアルを使用したイベント スケジュールの作成」を参照してください。
次のすべての手順を行うには、Jira システム管理者グローバル権限を持つユーザーとしてログインする必要があります。
サービスの登録
独自に作成したサービスの場合、サービス クラスが Jira で認識できるクラス パスにあることを確認します。通常、最適な場所は Jira アプリケーションのインストール ディレクトリの <jira-application-dir>/WEB-INF/classes
または <jira-application-dir>/WEB-INF/lib
サブディレクトリです (JAR ファイルとして設定)。
サービスを登録するには、次の手順に従います。
- 画面右上で [管理] > [システム] の順に選択します。
- [詳細] (左側のパネル) で、[サービス] を選択して、すべての設定済みサービスを表示するページを開きます。
- ページの下部にある サービスの追加 フォームで、次のフィールドの入力を完了します。
- 名前 - このサービスの記述名。
クラス — サービスの完全修飾クラス名。
com.atlassian.jira.service.services.
type.Type
Service
のような書式になります。
提供されるサービス クラス名については、サービスの例を参照してください。Jira の組み込みのサービス クラスのいずれかを使用するには、[組み込みサービス] リンクをクリックしてサービス クラスの一覧を展開し、一覧内の特定のクラスの名前をクリックします。組み込みサービスの完全修飾クラス名が [クラス] フィールドに追加されます。
- 遅延 - サービス実行間の遅延(分単位)。
たとえば、デバッグ サービスを追加するには、組み込みサービスをクリックし、次にデバッグ サービスリンクをクリックします。
[サービスの追加] フォームのフィールドへの入力が終了したら、[サービスの追加] ボタンをクリックします。これにより、[サービスの編集] ページが開き、新しいサービスのオプションを設定できます。
サービスのオプションは、選択したサービスのタイプ(すなわちクラス)によって異なります。
- 編集サービス ページの残りのオプション設定を完了したあと、更新 ボタンをクリックして、新しいサービスのオプションを保存します。
サービス プロパティの編集
- 画面右上で [管理] > [システム] の順に選択します。
- [詳細] (左側のパネル) で、[サービス] を選択して、すべての設定済みサービスを表示するページを開きます。
- プロパティを編集するサービスに関連付けられた [編集] リンクを選択します。
たとえば、Jira からメールが送信される間隔を変更するには、[メール キュー サービス] を編集し、[遅延] を既定値の 1 分から変更します。
サービスの削除
- 画面右上で [管理] > [システム] の順に選択します。
- [詳細] (左側のパネル) で、[サービス] を選択して、すべての設定済みサービスを表示するページを開きます。
- 削除するサービスに関連付けられた [削除] リンクを選択します。
組み込みサービス
Jira にはすぐに利用できる便利なサービスが含まれており、そのまま使用することも、独自の環境で使用するために修正することもできます。組み込みサービスのすべてのソース コードが利用可能で、独自のサービスを作成するための例として利用できます。すべての組み込みサービスは Jira に含まれており、設定を行うだけで使用できます。
エクスポート サービス
エクスポート サービスは、Jira を定期的にバックアップするのに便利です。このサービスが実行されるたびに、パラメータとして指定されたディレクトリに、Jira のすべてのデータがエクスポートされます。エクスポート ファイルにはタイムスタンプが設定されるため、このサービスはバックアップ システムとして利用できます。
このサービスをテストするには、com.atlassian.jira.service.services.export.ExportService クラスを使用するサービスを追加します。Jira は (セットアップ ウィザードが完了したあとに) 新しい Jira インストールにエクスポート サービスを設定します。そのため、このサービスはすでに設定されている可能性があります。
You can find this class within the following directory of an expanded Jira source archive (which can be downloaded by Jira customers from https://my.atlassian.com):<source-installation-directory>/jira-project/jira-components/jira-core/src/main/java/com/atlassian/jira/service/services/export
メールハンドラ サービス
Jira のメール ハンドラ サービスは、Jira の [サービス] ページでは設定できません (削除する場合を除く)。カスタム メール ハンドラの作成を含む、Jira のメール ハンドラ設定の詳細については、「メールから課題やコメントを作成する」を参照してください。
カスタム サービス
Jira を使用する開発者が独自の Jira サービスを作成する場合、Jira サービス クラスはすべて、com.atlassian.jira.service.JiraService を拡張する必要があることにご注意ください。大半のサービスは、com.atlassian.jira.service.AbstractService またはより特化したサブクラスによって拡張されます。