ServiceDesk Plus のデータ のPostgreSQL インターフェースを作成
PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。
ServiceDesk Plus にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for API とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからServiceDesk Plus にクエリを実行します。
JDBC データソースとしてServiceDesk Plus のデータに接続する
JDBC データソースとしてServiceDesk Plus に接続するには、以下が必要です。
- Driver のJAR パス:JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。
Driver クラス
cdata.jdbc.api.APIDriver
- JDBC URL:
URL は、"jdbc:api:" で始まり、セミコロンで区切られた名前と値の組み合わせで任意の接続プロパティを含めることができます。
OAuth 認証の設定
ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます:
- https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
- アプリケーション構成に合わせてリダイレクト URI を設定します
- アプリケーション設定から Client ID と Client Secret を控えておきます
以下の接続プロパティを設定して接続を確立してください:
- AuthScheme:OAuth に設定します。
- OAuthClientId:Zoho アプリケーションの Client ID に設定します。
- OAuthClientSecret:Zoho アプリケーションの Client Secret に設定します。
- Scope:必要な ServiceDeskPlus の権限に設定します(デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます)。
- Domain:ServiceDeskPlus のドメインに設定します。
- Portal:ServiceDeskPlus のポータルに設定します。
接続文字列の例
Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
ビルトイン接続文字列デザイナ
JDBC URL の構成については、ServiceDesk Plus JDBC Driver に組み込まれている接続文字列デザイナを使用できます。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
以下は一般的なJDBC URL です。
jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
JDBC FDW を構築する
FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。
- ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例:
ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
- ビルドするには、以下のコマンドを実行してください。
make install USE_PGXS=1
ServiceDesk Plus のデータをPostgreSQL データベースとしてクエリする
拡張機能をインストールした後、以下のステップに従ってServiceDesk Plus へのクエリの実行を開始します。
- データベースにログイン
-
データベースの拡張機能をロード
CREATE EXTENSION jdbc2_fdw;
-
ServiceDesk Plus のオブジェクトを作成
CREATE SERVER API FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.api.APIDriver', url 'jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar');
-
PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成
CREATE USER MAPPING for postgres SERVER API OPTIONS ( username 'admin', password 'test');
-
ローカルデータベースに外部テーブルを作成
postgres=# CREATE FOREIGN TABLE announcementcomments ( announcementcomments_id text, announcementcomments_ text, announcementcomments_ numeric) SERVER API OPTIONS ( table_name 'announcementcomments');
postgres=# SELECT * FROM announcementcomments;
おわりに
このようにCData JDBC Driver for API を使って簡単にServiceDesk Plus のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。