Salesforce Connect で Jira 外部オブジェクトを編集・検索(API Server)
CData API Server を使用すると、Salesforce コンソールや Salesforce1 モバイルアプリなどのクラウドベースのアプリケーションからJira のデータにアクセスできます。この記事では、API Server と Salesforce Connect を使用して、標準の Salesforce オブジェクトと一緒に Jira 外部オブジェクトにアクセスする方法を説明します。
Jira データ連携について
CData は、Jira のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています:
- Issue、Project、Workflow などの Jira オブジェクトへの双方向アクセスを実現します。
- SQL ストアドプロシージャを使用して、Issue のステータス変更、カスタムフィールドの作成、添付ファイルのダウンロード・アップロード、時間追跡設定の変更・取得などの機能的なアクションを実行できます。
- ユーザー名とパスワード、OAuth、パーソナルアクセストークン、API トークン、Crowd または OKTA SSO、LDAP など、さまざまな方法で安全に認証できます。
多くのユーザーは、CData Sync を直接使用するか、SSIS や Azure Data Factory などのプラットフォームとの CData の互換性を活用して、Jira データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用しています。また、Tableau や Power BI などのお気に入りの分析ツールからライブ Jira データの分析やレポートを行いたい方もいます。
お客様がビジネス上の問題を解決するために Jira データにシームレスに接続している方法については、ブログをご覧ください:Drivers in Focus: Collaboration Tools
はじめに
API Server のセットアップ
まだインストールしていない場合は、CData API Server をダウンロードしてください。API Server をインストールしたら、以下の手順に従ってセキュアな Jira OData サービスの作成を開始します。
Jira への接続
Salesforce Connect からJira のデータを操作するには、まず Jira への接続を作成・設定します。以下の手順で API Server を設定してJira のデータに接続します。
- まず、Connections ページに移動します。
-
Add Connection をクリックし、Jira 接続を検索して選択します。
-
Jira に接続するために必要な認証プロパティを入力します。
JIRA への接続には、User、Password およびURL を使います。URL はhttps://yoursitename.atlassian.net などです。
- 接続を設定したら、 Save & Test をクリックして接続が成功したことを確認します。
API Server のユーザー設定
次に、API Server を通じてJira のデータにアクセスするユーザーを作成します。Users ページでユーザーを追加・設定できます。以下の手順でユーザーを設定・作成します。
- Users ページで、 Add User をクリックして Add User ダイアログを開きます。
-
次に、Role、Username、Privileges プロパティを設定し、Add User をクリックします。
-
その後、ユーザーの Authtoken が生成されます。各ユーザーの Authtoken やその他の情報は Users ページで確認できます。
Jira 用の API エンドポイントの作成
ユーザーを作成したら、Jira テーブル用の API エンドポイントを作成します。
-
まず、API ページに移動し、 Add Table をクリックします。
-
アクセスしたい接続を選択し、Next をクリックします。
-
接続を選択した状態で、各テーブルを選択し、Confirm をクリックしてエンドポイントを作成します。
OData URL の取得
Jira のデータへの接続を設定し、ユーザーを作成し、API Server にリソースを追加したので、これらのリソース用の OData プロトコルに基づいた簡単にアクセスできる REST API が利用可能になりました。API Server の API ページから、API の API エンドポイントを表示およびコピーできます。
Jira のデータ を外部データソースとして接続
以下の手順に従って、API Server が生成するフィードに接続します。
- Salesforce にログインし、設定 -> 開発 -> 外部データソース をクリックします。
- 「新規外部データソース」をクリックします。
- 以下のプロパティの値を入力します:
- 外部データソース:リストビューやレポートで使用するラベルを入力します。
- 名前:一意の識別子を入力します。
- 種類:「Salesforce Connect: OData 4.0」オプションを選択します。
URL:API Server の OData エンドポイントへの URL を入力します。URL の形式は https://your-server:your-port/api.rsc です。
注意:プレーンテキストはテスト専用です。本番環境では TLS を使用してください。
- 「書き込み可能外部オブジェクト」オプションを選択します。
「形式」メニューで JSON を選択します。
- 「認証」セクションで、以下のプロパティを設定します:
- ID 種類:組織のすべてのメンバーが同じ資格情報を使用して API Server にアクセスする場合は、「指定プリンシパル」を選択します。組織のメンバーが独自の資格情報で接続する場合は、「ユーザーごと」を選択します。
- 認証プロトコル:Basic 認証を使用する場合は「パスワード認証」を選択します。
- 証明書:Salesforce からサーバーへの通信を暗号化・認証するために使用する証明書を入力または参照します。
- ユーザー名:API Server のユーザー名を入力します。
- パスワード:ユーザーの Authtoken を入力します。
Jira オブジェクトの同期
外部データソースを作成したら、以下の手順に従って、データソースの変更を反映する Jira 外部オブジェクトを作成します。Jira 外部オブジェクトの定義を Jira テーブルの定義と同期します。
- 作成した外部データソースのリンクをクリックします。
- 「検証して同期」をクリックします。
- 外部オブジェクトとして操作する Jira テーブルを選択します。
Jira のデータ を Salesforce オブジェクトとしてアクセス
Jira のデータ を外部データソースとして追加し、Jira テーブルを Jira 外部オブジェクトと同期したら、標準の Salesforce オブジェクトと同様に外部オブジェクトを使用できます。
-
フィルターリストビューを持つ新しいタブを作成:
-
標準 Salesforce オブジェクトと一緒に Jira 外部オブジェクトの関連リストを表示:
-
Salesforce ダッシュボードのタブから Jira オブジェクトの作成、読み取り、更新、削除:
トラブルシューティング
一般的な接続の問題を避けるために、以下のチェックリストを使用できます:
- サーバーにパブリックアクセス可能な IP アドレスがあることを確認してください。これに関連して、OS レイヤーで、ファイアウォールが API Server が実行されているポートを開いていることを確認する必要があります。アプリケーションレイヤーでは、管理コンソールの Settings -> Security タブで信頼できる IP アドレスを追加していることを確認してください。
- 商用の信頼できる CA からの SSL 証明書で保護された接続を使用していることを確認してください。Salesforce は現在、自己署名証明書や内部 CA を受け入れていません。
API Server をホストしているサーバーが TLS 1.1 以上を使用していることを確認してください。.NET API Server を使用している場合は、.NET API Server の組み込みサーバーを使用することで実現できます。
IIS を使用している場合、TLS 1.1 および 1.2 はサポートされていますが、デフォルトでは有効になっていません。これらのプロトコルを有効にするには、MSDN のハウツーと Microsoft 技術リファレンスを参照してください。
Java エディションを使用している場合、TLS 1.2 は Java 8 ではデフォルトで有効ですが、Java 6 または 7 では有効ではありません。これらの以前のバージョンを使用している場合は、この Oracle ハウツーを参照してください。