Unqork でHubDB に接続されたアプリケーションを作成

杉本和也
リードエンジニア

CData Connect AI を使ってUnqork にHubDB のデータを渡し、カスタムの業務アプリを作成。

概要

CData Connect AI を使えば、Unqork からHubDB のデータを取得できます。そのデータを使って、カスタムの業務アプリケーションをドラッグドロップ操作で作成できます。この記事ではそのための手順を説明します。

Unqork はあらゆる操作を視覚的に実行できるノーコードの開発プラットフォームで、大企業の複雑なカスタムソフトウェア作成を支援します。CData Connect AI はHubDB をREST エンドポイントとして公開するので、Unqork 側で簡単なHTTP リクエストを使ってクエリできます。この方法で、HubDB のデータを使ったカスタムアプリケーションを作成できます。

この記事を読んでわかること

本記事では、次の点について説明します。

CData Connect AI のユーザーを追加する方法。
Connect AI ユーザー用のパーソナルアクセストークンを追加する方法。
Connect AI からHubDB に接続する方法。
Connect AI にHubDB OData エンドポイントを追加する方法。
Connect AI 経由でHubDB をUnqork サービスとして登録する方法。
HubDB のデータを表示するための簡単なUnqork アプリケーションを作成する方法。

CData Connect AI を構成する

Unqork からHubDB のデータを扱うには、以下の手順が必要です。

CData Connect AI からHubDB に接続。
CData Connect AI で新しいコネクションにユーザーアクセス権限を追加。
HubDB のデータのOData エンドポイントを作成。

（オプション）新しいConnect AI ユーザーを追加

必要な際には、Connect AI 経由でHubDB に接続するユーザーを作成してください。

Users ページに移動して、 Invite Users をクリックします。
新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
Users ページからユーザーを確認、変更できます。

パーソナルアクセストークンを追加する

OAuth 認証をサポートしないサービス、アプリケーション、プラットフォーム、フレームワークから接続する場合、パーソナルアクセストークン（Personal Access Token, PAT）を認証に使用できます。きめ細かくアクセスを管理するために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
PAT の名前を入力して Create をクリックします。
パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からHubDB に接続する

Connect AI にログインし、 Add Connection をクリックします。
Add Connection パネルから「HubDB」を選択します。
必要な認証情報を入力し、HubDB に接続します。
HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

カスタムOAuthアプリを使用する

すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。
1. HubSpotアプリ開発者アカウントにログインします。
  - アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
2. 開発者アカウントのホームページで、アプリタブをクリックします。
3. アプリを作成をクリックします。
4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
  - デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
  - Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。
8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。
  
  テーブルにアクセスするには、最低限以下のスコープが必要です：
  - hubdb
  - oauth
  - crm.objects.owners.read
9. 変更を保存をクリックします。
10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
  - 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
  - コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
  - アプリを接続をクリックします。結果のタブは閉じて構いません。
プライベートアプリを使用する

HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

以下の手順に従ってプライベートアプリケーショントークンを生成できます：
1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
3. プライベートアプリを作成をクリックします。
4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。
接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。
Create & Test をクリックします。
Add HubDB Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にHubDB のOData エンドポイントを追加する

HubDB に接続したら、目的のテーブルのOData エンドポイントを作成します。

OData ページに移動して、 Add をクリックそ新しいOData エンドポイントを作成します。
HubDB のコネクション（例：HubDB1）を選択し、Next をクリックします。
使用するテーブルを選択し、Confirm をクリックします。

OData フィードのサンプルURL

HubDB への接続を構成してユーザーを作成し、Connect AI でOData エンドポイントを作成すると、HubDB のデータのOData フィードにアクセスできるようになります。以下は、テーブルにアクセスするためのURL とテーブルのリストです。テーブルへのアクセスについては、Connect AI のOData ページを参照してください。 URL はConnect AI のものが必要です：https://cloud.cdata.com/api/odata/service。

テーブル		URL
エンティティ（テーブル）一覧		https://cloud.cdata.com/api/odata/service/
メタデータ		https://cloud.cdata.com/api/odata/service/$metadata
NorthwindProducts		https://cloud.cdata.com/api/odata/service/NorthwindProducts

通常のOData フィードについては、返されるフィールドを制限したい場合は、クエリに$select パラメータと$filter、$orderby、$skip、$top といった他の一般的なOData URL パラメータを組み合わせて追加できます。サポートされているOData クエリの詳細についてはヘルプドキュメントを参照してください。

コネクションとOData エンドポイントを設定したら、Unqork からHubDB のデータに接続できます。

HubDB のデータを使った簡単なアプリケーションを作成

Connect AI でHubDB のREST API を設定したら、HubDB に接続したアプリケーションをUnqork で作成できます。以下がそのための基本的な手順です。

HubDB をUnqork サービスとしてConnect AI 経由で登録
Unqork 内にワークスペースを作成
module-type のアプリケーションを作成

HubDB をUnqork サービスとしてConnect AI 経由で登録

Connect AI に接続するには、ご利用の環境に外部サービスへの接続権限を付与する必要があります。Services Administration から付与を実行してください。

Unqork Designer Platform の右上端にある、Settings ドロップダウンメニューをクリックします。
Administration をクリックします。
Integrations 以下の、Services Administration をクリックします。
Service Title を入力します。例えば、Connect AI。
Service Name を入力します。例えば、cdataConnect。
Service protocol + host を入力します。これは参照したいAPI エンドポイントのことです。例えば、 https://cloud.cdata.com/api/odata/service。
Type of Authentications ドロップダウンメニューからBasic Auth を選択します。
Connect AI のユーザーID（例：[email protected]）をUser Name フィールドに入力します。
Connect AI のユーザーのPAT をPassword フィールドに入力します。
Add Service をクリックします。

Workspace を作成する

Unqork では自身のワークスペースを作成することができ、それが自身やチームがアプリケーションを保存したり整理したりする仮想コンテナとなります。ワークスペースを作成したら、そこにアプリケーションを追加できます。

ワークスペースを作成するには、以下の手順を実行します。

Create Workspace をクリックします。
一意のWorkspace Name を入力します。
Create をクリックします。

作成したワークスペースタイルがWorkspaces タブ以下に表示されます。

Module-Type のアプリケーションを作成する

ワークスペースを追加したら、アプリケーションを作成できます。module-type もしくはworkflow-type のアプリケーションを選択できます。今回の例では、module-type のアプリケーションを作成します。

開いたワークスペースからApps に移動します。
Create Workspace をクリックします。
一意のApp Name を入力します。
Style ドロップダウンメニューからプレビュースタイルを選択します。スタイルはアプリケーションの外観を指定します。空白にした場合は、アプリケーションは環境のデフォルトスタイルを使用します。
App Type ドロップダウンメニューからModule を選択します。
App Entrypoint Module ドロップダウンメニューからNew Entrypoint Module を選択します。
Create をクリックします。

新しいアプリケーションのModules タブに移動します。次のように表示されます。

モジュールに名前をつけるには、Module Editor でタイトルをクリックします。

アプリケーションの作成を完了するには、次のコンポーネントが必要です。

Hidden コンポーネント：Plug-In で取得したデータを格納します。
Initializer コンポーネント：テーブルを表示する際にPlug-In を実行します。
Plug-In コンポーネント：Connect AI からHubDB のデータを取得してHidden コンポーネントに格納します。
ViewGrid コンポーネント：Hidden コンポーネントに格納したデータからHTML テーブルを作成します。

Hidden コンポーネントを設定する

Hidden コンポーネントはConnect AI から取得したHubDB のデータを格納します。

Hidden コンポーネントをキャンバスにドラッグドロップします。
Property ID とCanvas Label Text を入力します。

NOTE：Property ID はキャメルケース（camelCase のように）にする必要があります。例えば、hiddenComponent です。Hidden コンポーネントユーザーには表示されないので、Property ID をCanvas Label Text として使用してください。
Save をクリックします。

Plug-In コンポーネントを設定する

次に、Connect AI にデータをリクエストするためのPlug-In コンポーネントを追加します。このコンポーネントは、Service Administration で設定したサービスに接続します。

Plug-In コンポーネントを、キャンバスのHidden コンポーネントの下にドラッグドロップします。
Property ID とCanvas Label Text を入力します。

NOTE：キャメルケース（camelCase のように）を使用する必要があります。Plug-In のProperty ID はplugin で始めるのがベストプラクティスです。例えば、pluginGetAWProducts。
Outputs テーブルを次のように設定します。
- Hidden コンポーネントのProperty ID をProperty ID カラムに入力します。
- value をMapping カラムに入力します。
Service Type としてExternal を選択します。
External Services ドロップダウンメニューから、Connect AI サービスを選択します。これは、Services Administration で設定した外部サービスです。
Data Sources URL の最後にConnect AI リソースの特定のエンドポイントを追加します。例えば、AdventureWorks2012_Production_Product です。

NOTE：データソースのURL は、https://cloud.cdata.com/api/odata/service/AdventureWorks2012_Production_Product と類似の値となります。
Save をクリックします。

Initializer コンポーネントを設定する

Initializer コンポーネントは、HubDB のデータを取得するPlug-In を実行するためのものです。

Initializer コンポーネントを、キャンバスのPlug-In コンポーネントの上にドラッグドロップします。
Property ID とCanvas Label Text を入力します。

NOTE：キャメルケース（camelCase のように）を使用する必要があります。Initializer のProperty Name はinit で始めるのがベストプラクティスです。例えば、initGetAWProducts です。
Trigger Type としてNew Submission を設定します。
Outputs テーブル内に次を入力します。
- Plug-In のProperty ID をProperty ID カラムのフィールドに入力します。
- Type カラムのフィールドにtrigger と入力します。
- Value カラムのフィールドにGO と入力します。
Save をクリックします。

ViewGrid コンポーネントを設定する

ViewGrid コンポーネントはHidden コンポーネントに格納されたデータを参照します。その後、ダッシュボード（またはテーブル）にHubDB のデータを表示します。

ViewGrid コンポーネントを、キャンバスのPlug-In コンポーネントの下にドラッグドロップします。
Label とProperty Name を入力します。

NOTE：キャメルケース（camelCase のように）を使用する必要があります。ViewGrid のProperty Name はvg で始めるのがベストプラクティスです。例えば、vgAWProductView です。
Inputs テーブルで、id をHidden コンポーネントのProperty ID に設定します。
Display テーブルで次を設定します。
- id カラム内に、表示したいフィールドのID を入力します。
- handing カラムに、各フィールド用のタイトルを入力します。フィールドは、自身とユーザーに次のように表示されます。
Save をクリックします。
Save ボタンでモジュールを保存します。

上のコンポーネントを追加、設定したら、アプリケーションの自身とユーザーへの表示をプレビューできます。Module Editor で、Preview Module をクリックしてモジュールの前からの表示（"Express View"）を確認できます。

Express View モジュールは次のように表示されます。

詳細と無料トライアル

Connect AI とUnqork を組み合わせれば、HubDB に接続できるアプリケーションを簡単に作成できます。Connect AI の無償トライアルを始めてUnqork からすぐにHubDB のデータにアクセスしましょう。

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

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ