2 Jiraコネクタのインストールおよび構成

この章では、Jiraコネクタの設定と構成および関連タスクに関する次の情報を示します。

• 前提条件

• コネクタのインストール

• コネクタ・インスタンスの作成

• コネクタの構成

• コネクタの有効化または無効化

• 一般設定の指定

• チケット・テンプレートの使用

• コネクタの削除

前提条件

Jiraコネクタは、JiraのREST APIを介して通信します。Jiraコネクタを使用する前に、次の前提条件が満たされていることを確認してください。

• すべての必要な権限と従業員情報を備えたJiraユーザーが存在すること。

• My Oracle Supportの優先資格証明が設定されていること。資格証明を設定するには、次のステップを実行します。

  1. Enterprise Managerコンソールの「設定」メニューから「My Oracle Support」、「資格証明の設定」の順に選択します。
  2. ユーザー名とパスワード情報を入力し、「適用」をクリックします。
  3. Enterprise Managerコンソールの「設定」メニューから「拡張性」、「自己更新」の順に選択します。
  4. 「自己更新」ページから、表リスト内にあるJira Service Management REST Ticketing Connectorを探します。表示されていない場合は、次のステップに進みます。
  5. 次の図に示すように、「更新の確認」をクリックして、コネクタのメタデータを収集するジョブをスケジュールします。
     
     
     
     

ノート:

「自己更新」はオフライン・モードでも設定できます。詳細は、『Oracle Enterprise Manager Cloud Control管理者ガイド』のオフライン・モードでの更新の適用に関する項を参照してください。

コネクタのインストール

この項では、コネクタをダウンロードしてインストール(適用)するために必要な手順を説明します。Jiraコネクタはデフォルトでは含まれていないため、Oracle Enterprise Managerストアからダウンロードする必要があります。Enterprise Managerストア内のすべてのコネクタは「自己更新」ページからダウンロードできます。

コネクタをインストールするには、次のようにします。

1. Enterprise Managerコンソールの「設定」メニューから「設定」を選択し、「拡張性」、「自己更新」の順に選択します。

2. 「タイプ」列の「管理コネクタ」リンクをクリックします。

   Jiraコネクタが「使用可能」のステータスでリストに表示されます。

3. 適切なJiraコネクタをクリックして選択し、「ダウンロード」をクリックします。

   ダウンロードを実行する時期を決定できる「スケジュール・ダウンロード」ウィンドウが表示されます。

4. すぐにダウンロードするには、「選択」をクリックします。

   後でダウンロードするようにスケジュールする場合は、ダウンロードを実施する日時を指定し、「選択」をクリックします。その場合は、スケジュールしたダウンロード日時より後に、この手順に戻って残り部分を完了する必要があります。

5. 必要に応じて、コネクタのステータスが「ダウンロード済」に変わるまで画面をリフレッシュします。

6. Jira Service Management REST Ticketing Connectorをクリックして選択し、「適用」をクリックします。

   操作の確認を求めるプロンプトに応答すると、リクエストが送信されたことを示すページが表示されます。

7. コネクタのステータスが「適用スケジュール済み」から「適用」に変わるまで、画面をリフレッシュします。

コネクタ・インスタンスの作成

Jiraコネクタを使用するには、このコネクタ・タイプのインスタンスを1つ以上作成する必要があります。コネクタ・インスタンスとは、具体的な詳細(Jiraインスタンスのコネクタ名、APIトークン、プロジェクト・キーなど)によって構成されたコネクタのインスタンスのことです。同じコネクタ・タイプの複数のコネクタ・インスタンスがサポートされているため、Enterprise Managerで複数のJiraインスタンスを構成する柔軟性があります。

たとえば、Enterprise Managerは本番ターゲットおよびテスト・ターゲットを監視しているので、コネクタのインスタンスを2つ作成して、本番ターゲットのインシデントが1つめのコネクタ・インスタンスでチケットを作成し、テスト・ターゲットのインシデントが2つめのコネクタ・インスタンスでチケットを作成するようにEnterprise Managerを構成することができます。

コネクタ・インスタンスを作成するには、次の手順を実行します。

1. Enterprise Managerコンソールで、「設定」をクリックします。

2. ペインで拡張性を選択します。

3. 左ペインで「管理コネクタ」を選択します。

4. 「コネクタの作成」ドロップダウン・リストからコネクタ・タイプを選択して、「実行」ボタンをクリックします。

5. 次の画面で、コネクタの名前と説明を入力し、「OK」をクリックします。

   次の図に示すように、コネクタ・インスタンスが「管理コネクタ」ページに未構成として表示されます。

   
   
   
   
   

コネクタの構成

基本的な構成の場合、次のステップを実行します。

1. スーパー管理者として、Enterprise Managerコンソールで「設定」をクリックします。

2. 拡張性」、「管理コネクタ」の順にクリックします。

   「管理コネクタ」ページには、すべての作成済コネクタ・インスタンスのリストが表示されます。

   ノート:

   緑色のチェック・マークが付いたステータス列は、コネクタがすでに構成されていることを示します。

3. Jiraコネクタの「構成」ボタンをクリックします。「管理コネクタの構成」ページの「一般」タブが表示されます。

4. 必要な設定を行います。詳細は、一般設定の指定を参照してください。

5. 「OK」をクリックします。

   「管理コネクタ」ページが再度表示されます。次の図に示すように、Jiraコネクタの行では「ステータス」列にチェック・マークが付きます。

   
   
   
   
   

6. オプション: カスタマイズしたテンプレートは、ORACLE_HOME/binディレクトリからemctl register_template connectorコマンドを実行して登録します。このORACLE_HOMEは、OMSのOracleホーム・ディレクトリです。

   「チケット・テンプレート」タブをクリックすると、すべてのチケット・テンプレートを表示できます。

コネクタの有効化または無効化

システムからコネクタを再構成または削除することなく、コネクタ・インスタンスを有効または無効にできます。

「管理コネクタ」ページからコネクタを有効化または無効化するには、コネクタを選択し、「有効化」または「無効化」ボタンをクリックします。コネクタを無効化すると、「ステータス」列に赤い十字アイコンが表示されます。デフォルトでは、コネクタ・インスタンスが構成されるとすぐに有効になります。

ノート:

チケット発行操作には、有効なコネクタのみを使用できます。

一般設定の指定

ここからの各項では、次の図に示す「管理コネクタの構成」ページの「一般」タブで各種構成の詳細を指定する方法について説明します。

接続設定

Jiraコネクタは、Webサービスを通じてサービス・デスクと通信します。必須フィールドはアスタリスク(*)で示されています。

• Webサービス・エンドポイント - Jiraによって公開されるcreateTicket、updateTicketおよびgetTicket Webサービスのエンド・ポイント。それぞれに subdomainという変数があり、Jiraサブドメインで更新する必要があります。
• トークン - Jiraからチケットを取得、作成および更新するための権限を持つAPIトークン。ノート: APIトークンはbase64でエンコードされている必要があります。APIトークンをbase64でエンコードする方法については、Atlassianのガイドを参照してください: https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/#supply-basic-auth-headers

  Linux/UNIX/MacOSの場合:

  echo -n [e-mail]:api_token_string | base64

  Windows (Powershellを使用)の場合:

  $Text = ‘[e-mail]:api_token_string’ 
  $Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
  $EncodedText = [Convert]::ToBase64String($Bytes) 
  $EncodedText

• プロジェクト・キー - プロジェクト・チケットのプロジェクト・キーが作成されます。
• チケットID - Jiraシステムへの接続をテストするための既存のチケットID。このチケットを開く必要はありません。

Webコンソールの設定

Enterprise Managerによって作成されたJiraチケットへのリンクを、インシデントのコンテキストでコネクタが提示するようにするには、Webコンソールの設定が必要になります。

この機能を有効にするには、次のWebコンソールの設定を指定します。

• Webコンソールの有効化 — Enterprise Managerからのコンテキスト内でJiraインシデント・ページを起動できるようにするには、このボックスを選択します。
• Jiraサブドメイン — Jiraアカウントのサブドメイン。

猶予期間

管理者は、猶予期間の有効と無効を切り替えたり、その値を構成したりできます。デフォルトでは、猶予期間は無効になっています。詳細は、猶予期間を参照してください。この設定は、Jiraコネクタで処理されるすべてのインシデントに適用されます。猶予期間の間隔には、任意の整数値として時間数を使用できます。たとえば、1または2です。

再試行

「再試行」オプションを有効または無効にしたり、その間隔値を構成できます。デフォルトでは、「再試行」は無効化されています。詳細は、再試行を参照してください。この設定は、Jiraコネクタで処理されるすべてのインシデントに適用されます。再試行間隔には時間数を任意の整数値で使用できます。たとえば、-1または2です。

チケット・テンプレートの使用

Enterprise Managerでコネクタ・インスタンスを作成すると、関連するすべてのテンプレートをチケットの作成または更新操作に使用できます。7つのデフォルトのJiraテンプレートがあります。

• jiraStoryCreateAndUpdate.xsl
• jiraBugCreateAndUpdate.xsl
• jiraTaskCreateAndUpdate.xsl
• jiraSubtaskCreateAndUpdate.xsl
• jiraIncidentCreateAndUpdate.xsl
• jiraProblemCreateAndUpdate.xsl
• JiraServiceRequestCreateAndUpdate.xsl

ヒント:

これらのテンプレートの詳細情報は、「テンプレート・プロセス」を参照してください。

次の各項では、チケット・テンプレートの追加、表示、削除、および置換に関する情報を提供します。

チケット・テンプレートの追加

チケット・テンプレートはEnterprise Managerで認識される前に追加する必要があります。コネクタは、コネクタ・インスタンスが作成されたときに自動的に登録される即時利用可能なテンプレートを提供します。これらを編集する場合は、Enterprise Managerで直接編集できます。ただし、新規の(即時利用可能のものではない)テンプレートを使用する必要がある場合は、emctlコマンドを使用して新規のテンプレートを登録する必要があります。そうすれば、Enterprise Managerでテンプレートを編集できます。詳細は、「テンプレートの編集」を参照してください。

テンプレートを追加して登録するには:

1. emctlの実行権限と、チケット・テンプレートを読解する能力を持っていることを確認します。

2. テンプレートごとに、次のemctl register_template connectorコマンドを実行します。

   $ORACLE_HOME/bin/emctl register_template connector
   [-t <template.xml>]
   [-repos_pwd <repos password>]
   [-cname <connectorName>]
   [-iname <internalName>]
   [-tname <templateName>]
   [-ttype <templateType>]
   [-d <description>]
   

   詳細は次のとおりです。

   -t           Template(full path)
   -repos_pwd   Enterprise Manager Root (SYSMAN) Password
   -cname       Connector Name
   -iname       Template Internal Name
   -tname       Template Name Displayed
   -ttype       Template Type
                <templateType> 1 - inbound transformation
                <templateType> 2 - outbound transformation
                <templateType> 3 - XML outbound transformation
   -d           Description

例2-1 テンプレートの登録

The following command adds a new outbound template (newTemplate.xsl) for a connector instance with the name Jira Connector Instance:

emctl register_template connector
-t <template.xml>
-repos_pwd <repos password>
-cname "Jira Connector Instance"
-iname "newTemplate"
-tname "newTemplateOutbound"
-ttype 2
-d "Demo template"

テンプレート・コードの表示

テンプレート・コードを表示するには、次の手順を実行します。

1. コネクタ・インスタンスを選択し、「管理コネクタの構成」ページに移動します。

2. 次の図に示すように、「テンプレート」タブを選択します。

3. テンプレートのXSLTコードを表示するには、テンプレート名か「表示」をクリックします。

チケット・テンプレートはXSLT形式です。コードを理解するには、XSLTの基礎知識が必要です。

テンプレートの削除

テンプレートを削除するには、次の手順を実行します。

1. コネクタ・インスタンスを選択し、「管理コネクタの構成」ページに移動します。

2. 「テンプレート」タブを選択します。

3. テンプレートを選択して「削除」をクリックします。

4. 「はい」をクリックして削除操作を確認します。

テンプレートの編集

既存のチケット・テンプレートを編集するには、次の手順を実行します。

1. コネクタ・インスタンスを選択し、「管理コネクタの構成」ページに移動します。

2. 「テンプレート」タブを選択します。

3. テンプレートを選択して「編集」をクリックします。

4. 必要に応じて「説明」および「テンプレート・コンテンツ」フィールドを編集し、「保存」をクリックします。

チケット・テンプレートが自動的に登録されます。登録されているテンプレートを保存すると、リポジトリ内でテンプレートが更新されます。

テンプレートのリストア

テンプレートを編集またはカスタマイズした後、必要に応じて以前のデフォルト・コンテンツにリストアするには、次のステップを実行します。

1. コネクタ・インスタンスを選択し、「管理コネクタの構成」ページに移動します。

2. 「テンプレート」タブを選択します。

3. テンプレートを選択して「リストア」をクリックします。

4. リストアするために表示される確認のページで「はい」をクリックします。

コネクタの削除

「管理コネクタ」ページから、コネクタを選択して「削除」ボタンをクリックすることにより、コネクタを削除できます。コネクタを削除すると、関連付けられたすべてのインシデント・ルールがチケット発行操作用に構成されていない状態になります。

また、削除されたコネクタがそのコネクタ・タイプの唯一のコネクタ・インスタンスである場合は、対応するコネクタ・タイプも削除されます。

ノート:

前述のルールは、即時利用可能なコネクタ・タイプには適用されません。