SAP Lumira でHCL Domino のOData Feeds を取り込み

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData API Server を使って、SAP Lumira でHCL Domino に基づくビジュアライゼーションを作成できます。API Server により、リアルタイムデータへの接続が可能になります。ダッシュボードとレポートはオンデマンドで更新できます。この記事では、常に最新であるグラフを作成する方法を説明します。

CData API Server とは？

CData API Server は、以下のような特徴を持ったAPI 開発ツールです。

• あらゆるデータソースからAPI を生成：SQL Server、MySQL、Oracle、PostgreSQL、DB2 などのRDB、Excel、CSV、Google スプレッドシートなどCData の充実したコネクタライブラリを利用できます。
• 主要なデータ形式に対応：OData、REST、JSON、CSV / TSV など、主要な形式に対応しています。
• 一元管理でAPI を効率運用：単一の管理プラットフォーム上でAPI の更新、停止、共有が可能です。
• ノーコードでシンプルな設定：GUI ベースのインターフェースを使用して、複雑なコーディングなしでAPI を作成・セキュアに公開できます。

詳しくは、こちらの製品資料をご確認ください。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなHCL Domino OData サービスを作成していきましょう。

デプロイ

API Server は内蔵のJetty サーバー上で動作します。Windows をお使いの場合は、スタンドアロンサーバーとして起動するか、IIS に組み込んで使用することが可能です。また、お使いのJava サーブレットコンテナにAPI Server のWAR ファイルを配置して実行することもできます。具体的なセットアップ方法については、こちらのヘルプドキュメントをご覧ください。

HCL Domino への接続

Salesforce Connect からHCL Domino のデータを操作するには、まずHCL Domino への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「HCL Domino」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、HCL Domino への接続設定を行っていきましょう！

5. Domino への接続

   Domino のデータに接続するには、以下のプロパティを設定してください。

   • URL: Domino データベースをホスティングしているサーバーのホスト名、またはIP を入力します。サーバーのポート番号を含めてください。例えば、http://sampleserver:1234/。
   • DatabaseScope: Domino Web UI 内のスコープ名を入力します。ドライバーは、ここで指定したスコープによって制御されるスキーマの、フォームとビューを公開します。Domino Admin UI で、サイドバーからScopes メニューを選択します。このプロパティを、既存のスコープ名に設定します。

   Domino での認証

   Domino は、ログインクレデンシャルまたはAzure Active Directory OAuth アプリケーションを使用した認証をサポートしています。

   ログインクレデンシャル

   ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

   • AuthScheme: これを"OAuthPassword" に設定します
   • User: 認証するDomino ユーザーのユーザー名
   • Password: 認証するDominoユ ーザーに関連付けられたパスワード

   ドライバーはログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

   AzureAD

   この認証方法は、Azure Active Directory をIdP として使用してJWTトークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。そのためには、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

   • AuthScheme: これを"AzureAD" に設定します
   • InitiateOAuth: これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます。
   • OAuthClientId: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントID
   • OAuthClientSecret: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントシークレット
   • CallbackURL: アプリ登録時に定義したリダイレクトURI。例えば、https://localhost:33333
   • AzureTenant: データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください。

     テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Domino への接続

Domino のデータに接続するには、以下のプロパティを設定してください。

• URL: Domino データベースをホスティングしているサーバーのホスト名、またはIP を入力します。サーバーのポート番号を含めてください。例えば、http://sampleserver:1234/。
• DatabaseScope: Domino Web UI 内のスコープ名を入力します。ドライバーは、ここで指定したスコープによって制御されるスキーマの、フォームとビューを公開します。Domino Admin UI で、サイドバーからScopes メニューを選択します。このプロパティを、既存のスコープ名に設定します。

Domino での認証

Domino は、ログインクレデンシャルまたはAzure Active Directory OAuth アプリケーションを使用した認証をサポートしています。

ログインクレデンシャル

ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

• AuthScheme: これを"OAuthPassword" に設定します
• User: 認証するDomino ユーザーのユーザー名
• Password: 認証するDominoユ ーザーに関連付けられたパスワード

ドライバーはログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

AzureAD

この認証方法は、Azure Active Directory をIdP として使用してJWTトークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。そのためには、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

• AuthScheme: これを"AzureAD" に設定します
• InitiateOAuth: これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます。
• OAuthClientId: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントID
• OAuthClientSecret: カスタムOAuth アプリケーションのセットアップ時に取得したクライアントシークレット
• CallbackURL: アプリ登録時に定義したリダイレクトURI。例えば、https://localhost:33333
• AzureTenant: データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください。

  テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

API Server のユーザー設定

次に、API Server 経由でHCL Domino にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

HCL Domino 用のAPI エンドポイントの作成

ユーザーを作成したら、HCL Domino のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でHCL Domino への接続を設定してユーザーを作成し、API Server でHCL Domino データのAPI を追加しました。これで、OData 形式のHCL Domino データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

SAP Lumira からHCL Domino への接続

以下のステップに従って、HCL Domino をSAP Lumira に取得します。SQL クエリを実行するか、UI を使用できます。

1. SAP Lumira で［File］->［New］->［Query with SQL］とクリックします。Add New Dataset ダイアログが表示されます。
2. ［Generic］セクションを展開し、［Generic OData 2.0 Connector］オプションをクリックします。
3. ［Service Root URI］ボックスに、API Server のOData エンドポイントを入力します。URL は次の例のようになります。 https://your-server:8032/api.rsc
4. ［User Name］と［Password］のボックスにAPI ユーザーのユーザー名と認証トークンを入力します。これらの資格情報は、HTTP 基本認証で使用されます。

5. ツリーでエンティティを選択するか、SQL クエリを入力します。この記事では、HCL Domino ByName エンティティをインポートします。

   

6. ［Connect］をクリックすると、SAP Lumira は対応するOData 要求を生成し、結果をメモリにロードします。その後、フィルタ、集計、要約関数など、SAP Lumira で使用可能な任意のデータ処理ツールを使用できます。

   

データのビジュアライゼーションを作成

データをインポートした後、［Visualize］ルームでデータのビジュアライゼーションを作成できます。以下のステップに従って、基本グラフを作成します。

1. ［Measures and Dimensions］ペインで、メジャーとディメンションを［Visualization Tools］ペインの［x-axis］フィールドと［y-axis］フィールドにドラッグします。SAP Lumira は、API Server のメタデータサービスからディメンションとメジャーを自動的に検出します。

   デフォルトでは、SUM 関数はすべてのメジャーに適用されます。メジャーの横にある歯車のアイコンをクリックしてデフォルトの要約を変更します。

2. ［Visualization Tools］ペインで、グラフの種類を選択します。
3. ［Chart Canvas］ペインで、フィルタを適用し、メジャーで並べ替え、ランキングを追加して現在のHCL Domino でグラフを更新します。