API Server とServiceDesk Plus ADO.NET Provider を使用して、Microsoft PowerPivot からServiceDesk Plus のデータにアクセス
この記事では、API Server を使用してMicrosoft Excel のPowerPivot ビジネスインテリジェンスツールでデータを活用する方法について説明します。以下のステップに従って、Power Pivot でServiceDesk Plus のデータを取得します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなServiceDesk Plus OData サービスを作成していきましょう。
ServiceDesk Plus への接続
PowerPivot からServiceDesk Plus のデータを操作するには、まずServiceDesk Plus への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「ServiceDesk Plus」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、ServiceDesk Plus への接続設定を行っていきましょう！
-
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;
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
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;
API Server のユーザー設定
次に、API Server 経由でServiceDesk Plus にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
ServiceDesk Plus 用のAPI エンドポイントの作成
ユーザーを作成したら、ServiceDesk Plus のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でServiceDesk Plus への接続を設定してユーザーを作成し、API Server でServiceDesk Plus データのAPI を追加しました。これで、OData 形式のServiceDesk Plus データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
さらに、「Settings」->「Server」をクリックし、Excel との互換性のために「デフォルトフォーマット」を「XML (Atom)」に設定します。
API Server ユーザーを認証する
作成するOData サービスを決定したら、「Settings」->「Users」とクリックしてユーザーを認証します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。IP アドレスを使用してアクセスを制限することも可能です。デフォルトではローカルマシンへの接続のみが許可されます。SSL を使用すれば、接続の認証だけでなく暗号化も可能です。
Power Pivot でServiceDesk Plus テーブルをインポートする
以下のステップに従って、必要に応じて更新もできるテーブルをインポートします。
- Excel で「PowerPivot」タブの「PowerPivot Window」アイコンをクリックしてPowerPivot を開きます。
- 「Home」->「Get External Data」->「From Data Service」->「From OData Data Feed」とクリックします。
-
認証パラメータを追加します。「Advanced」をクリックして「Integrated Security」オプションを「Basic」に設定します。CData API Server にアクセスできるユーザーのユーザーID とパスワードを入力する必要があります。 パスワードをユーザーの認証トークンに設定します。
-
「Base URL」ボックスで、CData API Server のOData URL を入力します。例：http://localhost:8032/api.rsc
-
インポートするテーブルを選択し、「Finish」をクリックします。
Power Pivot でServiceDesk Plus のデータを操作することが可能になります。
