データブリッジの設定

データブリッジの設定

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

このページの概要
このページでは、社内ネットワーク内でホストされているサービスやデータベースにアプリケーションを接続するため、Zoho Creatorでデータブリッジを設定する方法について説明します。続行する前に、データブリッジの仕組みをご確認ください。
利用条件

1. 前提条件

プライベートネットワークでデータブリッジを設定するには、すべてのシステム要件を満たしていることを確認してください。詳細はこちら

2. データブリッジの詳細

項目

詳細

対応OS

Windows、Mac、Linux

通信方式

アウトバウンド接続

対応コネクター

MySQL、PostgreSQL、Oracle、MS SQL、Actian Zen、SAP HANA。すべてのコネクターの一覧

セキュリティ

暗号化されたメッセージベースのデータ交換

3. データブリッジの設定手順

3.1. Qntrl連携の設定

データブリッジを設定する前に、Zoho Creatorの[システム連携]でQntrlを設定する必要があります。これにより、Zoho Creatorとプライベートサービスの間で安全に通信できるようになります。
特権管理者は、[データブリッジ]([操作]内)でもQntrlを設定できます。

3.2. データブリッジの設定

[システム連携]でQntrlを設定した後、次の手順を実行します。
  1. [データブリッジ]([操作]内)に移動します。
  2. 一覧から、使用するOSとバージョン(例:[macOS - 64ビット])をクリックします。データブリッジのパッケージがzipファイルとしてシステムにダウンロードされます。手順に従い、社内のサービスやデータベースにアクセスできるマシンにデータブリッジをインストールします。

    Notesメモ:ダウンロードパッケージにアクセスできる期間は15日間のみです。
  1. インストールが完了すると、データブリッジが[データブリッジ]セクションの一覧ページに追加されます。

    Info
    ヒント:インストール後、データブリッジが[データブリッジ]セクションに表示されていることを確認してください。また、データブリッジが有効になっていることを確認してください。

3.3. サーバーへのデータブリッジのインストール

データブリッジは、使用するOSとインストールの管理方法に応じて、2種類のパッケージ形式のいずれかを使用してインストールできます。

OS

ZIP

Windows

[セクション3.3.1]

Linux

[セクション3.3.2]

Mac

[セクション3.3.3]

Notes
メモ:インストーラーでは、画面の案内に従って操作できます。ZIP方式は、スクリプトによる展開やヘッドレス環境への展開に適しており、コマンドラインから実行します。
インストール中に、プロキシ設定、外部Postgres設定、サービスユーザーアカウントの入力を求められます。操作はすべてのOSで共通です。
  • プロキシ設定:サーバーがプロキシ経由でインターネットに接続する場合は、プロキシのユーザー名、パスワード、ホスト、ポートを入力します。それ以外の場合は、この手順をスキップするか、プロキシを無効にします。
  • 外部Postgres設定:Databridgeで外部Postgresデータベースを使用する場合は、そのホスト、ポート、ユーザー名、パスワードを入力します。それ以外の場合は、同梱のPostgresが使用されます。
  • サービスユーザーアカウント:Databridgeの実行に使用する、root以外のローカルユーザーアカウントです。このアカウントには管理者権限を付与せず、あらかじめサーバー上に作成しておく必要があります。ZIPインストーラーで入力を求められた際にユーザーが存在しない場合は、サービスの実行に必要な権限のみを持つユーザーを作成できます。

3.3.1. ZIPを使用したWindowsへのインストール(管理者権限のPowerShellのみ)  

  1. CreatorからDatabridgeエージェントのZIPファイルをダウンロードします。
  2. 管理者権限でPowerShellウィンドウを開き([管理者として実行])、エージェントのZIPファイルを展開します。
    # エージェントのZIPファイルを展開 Expand-Archive-Force Bridge.zip 'C:\Bridge'

      Bridge.zipを、実際にダウンロードしたZIPファイルのパスに置き換えます。 

  1. インストールスクリプトをroot権限で実行して、インストールを開始します。

  2. # インストールスクリプトを実行cmd.exe /c 'C:\Bridge\bin\bridge.bat install'
  1. 表示されたプロキシ設定のプロンプトで、次のいずれかを選択します。

    • [はい] - プロキシのユーザー名、パスワード、ホスト、ポートを入力して、プロキシを設定します。
    • [いいえ] - プロキシを無効にします。
    • [スキップ] - プロキシ設定を変更しません。
  1. 表示されたPostgres設定のプロンプトで、次のいずれかを選択します。
    • [はい] - ホスト、ポート、ユーザー名、パスワードを入力して、外部Postgresを設定します。
    • [いいえ] - 外部Postgresを無効にし、同梱のPostgresを使用します。
    • [スキップ] - Postgres設定を変更しません。
  1. 表示されたサービスユーザーのプロンプトで、システム上のroot以外のユーザー名を入力します。ユーザー名が存在しない場合、ユーザー作成のプロンプトで、サービスの実行に必要な権限のみを持つユーザーを作成できます。
  2. Databridgeが正常に起動したことを確認します。
Notesメモ:WindowsでZIPインストールを行う場合は、管理者権限のPowerShellから実行する必要があります。通常のPowerShellセッションには、必要な権限がありません。 

3.3.2. ZIPを使用したLinuxへのインストール  

  1. CreatorからDatabridgeエージェントのZIPファイルをダウンロードします。
  2. ターミナルを開き、エージェントのZIPファイルを展開します。
  3. # エージェントのZIPファイルを展開 sudo unzip-d /Bridge Bridge.zip

Bridge.zipを、実際にダウンロードしたZIPファイルのパスに置き換えます。 

  1. インストールスクリプトをroot権限で実行して、インストールを開始します。

  2. # インストールスクリプトを実行 sudo sh/Bridge/bin/bridge.sh install
  1. 表示されたプロキシ設定のプロンプトで、次のいずれかを選択します。

    • [はい] - プロキシのユーザー名、パスワード、ホスト、ポートを入力して、プロキシを設定します。
    • [いいえ] - プロキシを無効にします。
    • [スキップ] - プロキシ設定を変更しません。
  1. 表示されたPostgres設定のプロンプトで、次のいずれかを選択します。
    • [はい] - ホスト、ポート、ユーザー名、パスワードを入力して、外部Postgresを設定します。
    • [いいえ] - 外部Postgresを無効にし、同梱のPostgresを使用します。
    • [スキップ] - Postgres設定を変更しません。
  1. [サービスユーザー]の入力画面で、システム上のroot以外のユーザー名を入力します。ユーザー名が存在しない場合は、ユーザー作成画面で、サービスの実行に必要な権限のみを持つユーザーを作成できます。
  2. Databridgeが正常に起動したことを確認します。

3.3.3. ZIPを使用したMacへのインストール  

  1. CreatorからDatabridgeエージェントのZIPファイルをダウンロードします。
  2. ターミナルを開き、エージェントのZIPファイルを展開します。
  3. # エージェントのZIPファイルを展開 sudo unzip-d /Library/Bridge Bridge.zip

Bridge.zipを、実際にダウンロードしたZIPファイルのパスに置き換えてください。 

  1. インストールを開始するには、root権限でインストールスクリプトを実行します。

  2. # インストールスクリプトを実行 sudo sh/Library/Bridge/bin/bridge.sh install
  1. [プロキシ設定]の入力画面で、次のいずれかを選択します。

    • [はい] - プロキシのユーザー名、パスワード、ホスト、ポートを入力して、プロキシを設定します。
    • [いいえ] - プロキシを無効にします。
    • [スキップ] - プロキシ設定を変更しません。
  1. [Postgres設定]の入力画面で、次のいずれかを選択します。
    • [はい] - ホスト、ポート、ユーザー名、パスワードを入力して、外部Postgresを設定します。
    • [いいえ] - 外部Postgresを無効にし、同梱のPostgresを使用します。
    • [スキップ] - Postgres設定を変更しません。
  1. [サービスユーザー]の入力画面で、システム上のroot以外のユーザー名を入力します。ユーザー名が存在しない場合は、ユーザー作成画面で、サービスの実行に必要な権限のみを持つユーザーを作成できます。
  2. Databridgeが正常に起動したことを確認します。
    Info

    DatabridgeへのSSL証明書のアップロード

    DatabridgeでMS SQL接続を設定する場合、接続を確立する前にSSL証明書をDatabridgeへアップロードする必要があります。次の手順に従って、証明書をローカル環境からDatabridgeへアップロードします。

    1. 証明書のPEM形式への変換

    Databridgeでは、証明書がPEM形式である必要があります。次のコマンドを実行して、.cerファイルを.pem形式に変換します(すべてのプラットフォームで同じコマンドを使用します)。

    openssl x509 -inform der -in SQLSERVERCERFIXED.cer -outform pem -out SQLCertificate.pem

    2. Bridgeディレクトリー内のkeystoreフォルダーへの移動

    keystoreフォルダーは、Databridgeが信頼済み証明書を管理する場所です。適切な場所でインポートコマンドを実行するため、このディレクトリーに移動します。

    /Library/Bridge/conf/keystore

    3. OSに応じたインポートコマンドの実行

    証明書をインポートするには、keystoreフォルダーからOSに応じたコマンドを実行します。

    macOS/Unix/Linux:

    sh scripts/import_into_truststore.sh /Library/Bridge/jre /Library/Bridge
    bridge.truststore bridge <certificate_name> <certificate_file_path>

    Windows:

    scripts\import_into_truststore.bat C:\Library\Bridge\jre C:\Library\Bridge
    bridge.truststore bridge <certificate_name> <certificate_file_path>

    4. Databridgeの再起動

    証明書がトラストストアから読み込まれるよう、Bridgeサービスを再起動します。再起動後、Databridgeはアップロードした証明書を使用してMS SQLサーバーへの安全な接続を確立できるようになります。

    すべてのプラットフォーム。

    cd /Library/Bridge/bin

    sudo sh bridge.sh restart

3.4. Databridgeの インストール後の設定

  1. Creatorアカウントで、[Databridge]([操作]内)に移動します。一覧から必要なDatabridgeをクリックして開きます。
  2. Databridgeの詳細ページで、[接続を追加]をクリックします。
  3. プライベート環境でホストされているコネクターの一覧からコネクターを選択し、必要に応じて接続を作成します。コネクターの一覧には、プライベート環境でホストされているコネクターのみが表示されるよう、あらかじめ絞り込まれています。

  4. [接続を追加]ポップアップでは、Databridgeが自動的に選択されます。残りの詳細を入力して必要な設定を完了し、[作成して認証]をクリックします。接続の作成と認証の詳細はこちら

  5. [アカウントをリンク]ポップアップが表示されます。ユーザー名、パスワード、ホスト、ポート、サービス名を入力します。[認証]をクリックして接続を完了します。
  6. [マイクロサービス]セクションで、作成したプライベート環境でホストされているコネクターへの接続をアプリケーションから利用できるようにします。

Notesメモ:Databridgeと関連する接続は管理者が設定します。アプリケーションにアクセス権を付与するには、管理者が[マイクロサービス]セクションに移動し、対象のアプリケーションからのアクセスを有効にする必要があります。

設定が完了すると、Creatorアプリケーションからデータブリッジを介して、プライベート環境でホストされているサービスに安全にアクセスできます。データブリッジの詳細ページにある[接続]タブ、または[マイクロサービス]の[接続]タブから、さらに[接続]を作成できます。
Notes

 メモ:

  1. 接続を機能させるには、データブリッジを有効な状態に保つ必要があります。無効になると、アプリケーションから内部システムのデータにアクセスできなくなります。
  2. 1つのアカウントに追加できるデータブリッジは最大20件です。
  3. 同時に有効な接続を確立できるデータブリッジは最大5件です。
  4. データブリッジをインストールするマシンでは、外部へのインターネット接続が必要です。常時稼働する専用サーバーにインストールしてください。マシンがスリープまたは再起動すると、関連するすべてのワークフローが中断されます。

4. データブリッジの管理

データブリッジをインストールすると、[操作]の[データブリッジ]セクションから管理および監視できます。一覧ページには、アカウント内のすべてのデータブリッジと、そのホスト名、ポート、ステータスが表示されます。

4.1. データブリッジの詳細ページ

一覧ページでデータブリッジをクリックすると、詳細ページが開きます。左側の詳細パネルには、次の情報が表示されます。
  • [ホスト]-データブリッジがインストールされているサーバーのホスト名です。
  • [ホストOS]-ホストサーバーのオペレーティングシステム(Windows、Mac OS X、Linux)です。
  • [ポート]-データブリッジが待ち受けているポートです。
  • [最終ポーリング日時]-Creatorがデータブリッジを最後に正常にポーリングした日時です。
  • [ステータス]-[有効]または[ダウン]です。
    • 有効-データブリッジが稼働し、Creatorに接続され、データ操作を処理できる状態です。
    • ダウン-現在、Creatorからデータブリッジに接続できません。サービスが停止している、ホストサーバーがオフラインになっている、またはネットワークに問題がある場合に発生します。
  • [データブリッジのテスト]-Creatorとこのデータブリッジ間のチャネルを検証する[テスト]ボタンです。
  • [追加者]-このデータブリッジを追加したユーザーです。
  • [追加日]-データブリッジが追加された日付です。

4.1.1. データブリッジのテスト  

詳細パネルの[データブリッジのテスト]にある[テスト]ボタンを使用すると、Creatorから安全なチャネルを介してこのデータブリッジに接続できるかどうかを確認できます。
データブリッジをテストするには、次の手順を実行します。
  1. 一覧ページでデータブリッジを開き、詳細ページの[データブリッジのテスト]にある[テスト]をクリックします。
    • データブリッジは有効です-Creatorからデータブリッジに接続できました。データブリッジはデータ操作を処理できる状態です。
    • データブリッジはダウンしています-Creatorからデータブリッジに接続できませんでした。ホストサーバー上でデータブリッジサービスが実行されていることを確認し、サーバーから外部へのネットワーク接続を確認して、トラブルシューティングの手順を参照してください。
Notesメモ:テストでは、Creatorからデータブリッジへのチャネルのみが検証されます。データブリッジと内部サービスまたはデータベース間の接続はテストされません。

4.2 データブリッジでの操作

データブリッジの横にある三点リーダーをクリックすると、次の操作を実行できます。

4.2.1. 停止

ステータスが[有効]のデータブリッジは停止できます。
  1. 対象のデータブリッジの横にある三点リーダーをクリックし、[停止]をクリックします。
  2. 表示されたポップアップで[データブリッジを停止]をクリックします。
停止すると、データブリッジのステータスが[ダウン]に変わります。データブリッジを停止すると、Creatorアプリケーションを介したプライベートサービスとの通信が中断されます。

4.2.2. 参照先の表示   

データブリッジの参照先を表示するには、次の手順を実行します。
  1. 対象のデータブリッジの横にある三点リーダーをクリックします。
  2. [参照先を表示]をクリックします。このデータブリッジを使用している関連接続がポップアップに一覧表示されます。

  3. データブリッジが使用されている場所を確認するには、[参照先]をクリックします。アプリケーションで接続を開くには、[表示]をクリックします。 

4.2.3. 削除とアンインストール

データブリッジを削除できるのは、ステータスが[ダウン]の場合のみです。
  1. 対象のデータブリッジの横にある三点リーダーをクリックします。
  2. ポップアップで[削除]をクリックする前に、このデータブリッジを参照している一覧の接続を確認します。

Notesメモ:データブリッジに有効な接続がある間は削除できません。接続先を別のデータブリッジに切り替えるか、それらの接続を削除してから、もう一度お試しください。

データブリッジのアンインストール

Windows上で稼働しているプライベートホスト型サービスからデータブリッジをアンインストールする手順は、次のとおりです。
  1. 管理者権限でPowerShellを開きます。
  2. データブリッジを停止します:cmd.exe /c 'C:\Bridge\bin\bridge.bat' stop
  3. データブリッジサービスをアンインストールします:cmd.exe /c 'C:\Bridge\bin\bridge.bat' uninstall
  4. データブリッジのファイルを削除します:Remove-Item 'C:\Bridge' -Force -Recurse
macOS上で稼働しているプライベートホスト型サービスからデータブリッジをアンインストールする手順は、次のとおりです。
  1. ターミナルを開きます。
  2. データブリッジを停止します:sudo sh /Library/Bridge/bin/bridge.sh stop
  3. データブリッジサービスをアンインストールします:sudo sh /Library/Bridge/bin/bridge.sh uninstall
  4. システムからデータブリッジのファイルを削除します:sudo rm -rf /Library/Bridge

Linux上で稼働しているプライベートホスト型サービスからデータブリッジをアンインストールする手順は、次のとおりです。
  1. ターミナルを開きます。
  2. データブリッジを停止します:sudo sh /Library/Bridge/bin/bridge.sh stop
  3. データブリッジサービスをアンインストールします:sudo sh /Library/Bridge/bin/bridge.sh uninstall
  4. システムからデータブリッジのファイルを削除します:sudo rm -rf /Bridge

5. トラブルシューティング

問題

解決策

データブリッジが一覧に表示されない

ホストサーバーへのインストールが正常に完了していることを確認します。サービスが実行中であり、サーバーからインターネットに接続できることを確認してください。

データブリッジのステータスが停止中

ホストサーバー上のデータブリッジサービスを再起動します。サーバーの電源が入っており、ネットワーク経由でアクセスできることを確認してください。その後、Creatorの[テスト]操作を使用して、接続できることを確認します。

データが読み込まれない

組み込みの[テスト]オプションを使用して接続を確認します。データブリッジのステータスが有効であり、ホストサーバーから対象のサービスまたはデータベースに接続できることを確認してください。

6. 留意事項

  • データブリッジをインストールしたマシンからインターネットへの接続が必要です。常時電源が入っている専用サーバーにインストールしてください。マシンがスリープまたは再起動すると、関連するすべてのワークフローが中断されます。
  • ダウンロードしたデータブリッジパッケージの有効期間は15日間です。
  • 一度に有効に接続できるデータブリッジは最大5件です。
  • データソースを正しく動作させるには、データベースコネクターで自動採番項目をレコード識別子として使用する必要があります。
  • データブリッジ経由のAPI呼び出しは、組織ごとに1日5,000回までに制限されています。また、2分ごとに最大100回の呼び出しが許可されます。データベースコネクターおよびサービスコネクターを介してデータブリッジから実行されるAPI呼び出しは、外部APIまたは開発者向けAPIの利用上限にはカウントされません。

7. 用語集

  • データブリッジ:Zoho Creatorと、プライベートホスト型ネットワーク内のデータソースとの間で安全な通信を可能にする軽量エージェントです。
  • 送信接続:ネットワーク内部から外部サービスに対して開始される接続です。ファイアウォールで受信アクセスを許可する必要はありません。

8. 関連リンク