Halo Service Desk のデータ のPostgreSQL インターフェースを作成

加藤龍彦
加藤龍彦
デジタルマーケティング
Halo Service Desk JDBC Driver のリモート機能を使用し、データアクセス用のPostgreSQL エントリポイントを作成します。



PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

Halo Service Desk にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for API とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからHalo Service Desk にクエリを実行します。

JDBC データソースとしてHalo Service Desk のデータに接続する

JDBC データソースとしてHalo Service Desk に接続するには、以下が必要です。

  • Driver のJAR パス:JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。
  • Driver クラス

    
    cdata.jdbc.api.APIDriver
    
  • JDBC URL: URL は、"jdbc:api:" で始まり、セミコロンで区切られた名前と値の組み合わせで任意の接続プロパティを含めることができます。

    まず、Profile 接続プロパティをディスク上の HaloServiceDesk プロファイルの場所に設定します(例:C:\profiles\HaloServiceDesk.apip)。次に、ProfileSettings 接続プロパティを HaloServiceDesk の接続文字列に設定します(以下を参照)。

    HaloServiceDesk API プロファイル設定

    HaloServiceDesk では API キー認証を使用します。API キーは、HaloServiceDesk の「Administration」>「Integrations」>「Halo API」で確認・作成できます。

    接続するには、以下の接続プロパティを設定します。

    • AuthScheme:APIKey に設定します。
    • APIKey:HaloServiceDesk アカウントの API キーに設定します。
    • Domain:HaloServiceDesk インスタンスのホスト名に設定します(例:yourcompany.haloservicedesk.com)。

    ビルトイン接続文字列デザイナ

    JDBC URL の構成については、Halo Service Desk JDBC Driver に組み込まれている接続文字列デザイナを使用できます。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

    
    java -jar cdata.jdbc.api.jar
    

    接続プロパティを入力し、接続文字列をクリップボードにコピーします。

    Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    以下は一般的なJDBC URL です。

    
    jdbc:api:Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';
    

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

  1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例:
    
    ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
    
  2. ビルドするには、以下のコマンドを実行してください。
    
    make install USE_PGXS=1
    

Halo Service Desk のデータをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってHalo Service Desk へのクエリの実行を開始します。

  1. データベースにログイン
  2. データベースの拡張機能をロード
    
    CREATE EXTENSION jdbc2_fdw;
    
  3. Halo Service Desk のオブジェクトを作成
    
    CREATE SERVER API
    FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
    drivername 'cdata.jdbc.api.APIDriver',
    url 'jdbc:api:Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';',
    querytimeout '15',
    jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar');
    
  4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成
    
    CREATE USER MAPPING for postgres SERVER API OPTIONS (
    username 'admin',
    password 'test');
    
  5. ローカルデータベースに外部テーブルを作成
    
    postgres=# CREATE FOREIGN TABLE assets (
    assets_id text,
    assets_Id text,
    assets_InventoryNumber numeric)
    SERVER API OPTIONS (
    table_name 'assets');
    
Halo Service Desk に対してSELECTコマンドを実行可能にする

postgres=# SELECT * FROM assets;

おわりに

このようにCData JDBC Driver for API を使って簡単にHalo Service Desk のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。

はじめる準備はできましたか?

API Driver で Halo Service Desk のライブデータに接続

Halo Service Desk に接続