Jira Service Desk データでアップデートグラムを使用する

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

この記事では、CData BizTalk Adapter for JiraServiceDesk で実行できるアップデートグラムを作成します。設計したスキーマは、インサート、アップデート、デリートのアップデートグラムを作成するためのテンプレートとして使用します。

プロジェクトにJira Service Desk 用アダプターを追加する

［Add Adapter］ ウィザードから、アダプターをVisual Studio のBizTalk サーバープロジェクトに追加します。アダプターを使って、修正したいテーブルに関するJira Service Desk のメタデータをクエリします。

1. ［Solution Explorer］ の［project］ で右クリックし、［Add］ -> ［Add Generated Items］ と進みます。
2. ［resulting dialog box］ の［Add Adapter Metadata］ を選択します。
3. 表示される［Add Adapter］ ウィザードで、リストからCData BizTalk Adapter for JiraServiceDesk を選択します。
4. ［Port menu］ では、選択を空白のままにします。もしくは、アダプターを使用するように構成されている受信場所や送信ポートを選択します。
5. ［Next］をクリックすると、［Schema］ウィザードが表示されます。

アップデートグラム用のスキーマを作成する

以下のステップに従って、Visual Studio のBizTalk サーバープロジェクトでスキーマを作成します。

1. 未追加の場合は、Jira Service Desk アダプターをプロジェクトに追加します。
2. 送信ポートや受信場所で、認証資格情報やその他の接続プロパティが未構成の場合、［Add Adapter］ウィザードの［Connection String］ページから入力します。下は一般的な接続文字列です。

   ApiKey=myApiKey;User=MyUser;

   Jira Service Management 接続プロパティの取得・設定方法

   任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

   • URL（例：https://yoursitename.atlassian.net）

   カスタムフィールドへのアクセス

   デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

   Jira Service Management への認証

   ベーシック認証

   ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

   • AuthScheme：Basic に設定。
   • User：認証ユーザーのユーザー名に設定。
   • Password：認証ユーザーのパスワードに設定。

   API トークン

   Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

   データに接続するには以下を設定します。

   • AuthScheme：APIToken に設定。
   • User：認証ユーザーのユーザー名に設定。
   • APIToken：作成したAPI トークンに設定。

   ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

   OAuth 2.0

   Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

   この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

   接続プロパティの詳細は、ヘルプドキュメントの"BizTalk Configuration" チャプターを参照してください。

3. ［Schema Information］ページで、［General Options］セクションの［Send Port］をクリックします。［CommandType］メニューから［Updategram］を選択します。要請応答送信ポートのアダプターを使用している場合、［One-Way］オプションを無効にします。
4. 次の［Statement Information］ページでは、アップデートグラムの形式（Insert、Update、Delete）を選択します。 スキーマに含ませたいテーブル名とカラムを選択します。アップデートまたはデリートを行う場合、ID カラムを選択します。

   Noteアップデートグラムを作成する際、修正はスキーマに含ませたカラムに限定されます。

5. ［Next］をクリックしてスキーマの概要を確認してウィザードを終了し、スキーマを作成します。完成した.xsd ファイルがプロジェクトに追加されます。

インサート、アップデート、デリートのインスタンスメッセージを生成する

アップデートグラムスキーマの作成後、アップデートグラムを生成する.xsd ファイルを使用できます。.xsd ファイルを右クリックし、［Generate Instance］を選択します。このファイルは、アップデートグラムを手動で作成するテンプレートとして使用することもできます。以下は、インサート、アップデート、デリートそれぞれに生成されたアップデートグラムインスタンスの例です。

インサート

まず、インサートの一例です。このインスタンスでは、データの変化を指定するafter ブロックのみを扱います。

アップデート

次に、アップデートの一例です。このインスタンスでは、before ブロック（テーブルに存在するデータ）と、after ブロック（データの変化）の両方を扱います。

デリート

最後に、デリートの一例です。after ブロックは空になり、アイテムを除去していることを示します。

スキーマを処理する

Jira Service Desk レコードのインサート、アップデート、デリートにアップデートグラムを使用するには、こちらのチュートリアルをご覧ください。