製品をチェック

製品の詳細・30日間の無償トライアルはこちら

CData Connect

ノーコードアプリ開発ツールSAP Build Apps(AppGyver)でBitbucket 連携アプリを作成

CData Connect Server を使ってBitbucket データの仮想OData API エンドポイントを作成して、SAP Build Apps からBitbucket データを使ったアプリを作成する方法。

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

最終更新日:2023-09-21
bitbucket ロゴ

CData

connect ロゴ画像
SAP AppGyver ロゴ

こんにちは!リードエンジニアの杉本です。

SAP Build Apps(旧:AppGyver) は コーディングスキルを持たないユーザーでもWeb・モバイルアプリケーションを構築できるノーコード開発プラットフォームです。この記事では、CData Connect Server を経由して SAP Build Apps からBitbucket に連携するアプリを作成する方法を説明します。

CData Connect Server は、Bitbucket データのクラウド to クラウドの仮想OData インターフェースを提供し、SAP Build Apps からリアルタイムにBitbucket データへ連携することができます。

ホスティングについて

Build Apps からCData Connect Server に接続するには、利用するConnect Server インスタンスをネットワーク経由での接続が可能なサーバーにホスティングして、URL での接続を設定する必要があります。CData Connect がローカルでホスティングされており、localhost アドレス(localhost:8080 など)またはローカルネットワークのIP アドレス(192.168.1.x など)からしか接続できない場合、Build Apps はCData Connect Server に接続することができません。

クラウドホスティングでの利用をご希望の方は、AWS MarketplaceGCP Marketplace で設定済みのインスタンスを提供しています。


Bitbucket の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、Databases をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"Bitbucket" を選択します。
  3. Bitbucket に接続するために必要なプロパティを入力します。

    ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。

    Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。

    • Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
    • Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。

    Bitbucketでの認証

    BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。

    特定の認証ニーズ(デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン)に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。

    カスタムOAuthアプリケーションの作成

    Bitbucketアカウントから、以下のステップを実行します。

    1. 設定(歯車アイコン)に移動し、ワークスペース設定を選択します。
    2. アプリと機能セクションで、OAuthコンシューマーを選択します。
    3. コンシューマーを追加をクリックします。
    4. カスタムアプリケーションの名前と説明を入力します。
    5. コールバックURLを設定します。
      • デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
      • Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
    6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
    7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
    8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
    9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
    接続を設定
  4. Test Database をクリックします。
  5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

SAP Build Apps でアプリを作成する

それではSAP Build Apps 側でアプリ開発を開始します。

  1. 「CREATE NEW」をクリックし、
  2. 任意の名前でアプリを作成します。
  3. これで以下のようにアプリの開発画面が立ち上がります。

OData Integration の登録

アプリを作成したら、まず SAP Build Apps アプリでAPI 連携処理を行うための設定を追加します。

  1. 「DATA」タブから「OData Integration」を追加しましょう。
  2. 「Authentication Type」は「Basic authentication」を選択し、先ほど作成したCData Connect Server User のID とToken をそれぞれUsername・Passwordに入力します。 Base API URL はCData Connect Server のAPI タブにある「Base URL」で確認できます。これらを設定して「Verify URL」のボタンをクリックしましょう。
  3. すると自動的にCData Connect Server に登録されているAPI データモデルを読み取って、SAP Build Apps が扱いやすい形で「list」、「retreve」、「create」、「update」、「delete」処理が生成されます。
  4. 通常のREST API だと一つ一つ仕様を読み取って、登録していかなければいけないのですが、OData インターフェースに統一してくれるCData Connect Server を挟むことで、API の仕様を意識せず、SAP Build Apps で扱えるようになります。

変数の定義

それでは作成した OData Integration 機能を使ってアプリを作っていきます。とはいえ画面を作成する前に、API 経由で取得したデータを格納する変数を登録しておきましょう。

  1. 画面デザインページから「VARIABLES」に移動します。
  2. CData Connect Server から取得するデータ構造に合わせて変数を定義します。List とObject 構造の組み合わせで構成しましょう。

一覧画面の構成

変数を定義したら一覧画面を構成しましょう。

  1. 今回はCard 形式の画面を作成しますが、カードを繰り返し表示するためにまず「Container」を配置します。
  2. このContainer の中にCard を配置することで、カードが繰り返し表示される画面が構成できます。
  3. Card を配置後、Properties タブから「Repeat with」で先ほど作成した変数をバインドします。
  4. 「Data and Vaiables」を選択し
  5. 先ほど作成しておいたList の変数をバインドします。
  6. List の変数をバインドすると、Card にあるTitle やContent にもバインドできるようになります。
  7. 「Data item in repeat」でそれぞれの変数をバインドしましょう。

Logic の記述

最後にAPI から取得したデータを変数に格納するLogic を記述していきます。

  1. 画面下にあるLogic タブを開いて、ページを開いたときのLogic にAPI からデータを取得する「Get record collection」の処理を追加します。
  2. 「Get record collection」の処理には認証情報を設定する必要があるので「Authentication」をクリックします。
  3. 今回は固定値として設定するので「Obejct with properties」を選択し
  4. 「Authentication Type」から「basic」を選択した上で、CData Connect Server のID とAPI Token をそれぞれ設定して保存します。
  5. 次に取得したレコードを変数に格納します。「Set page variable」をLogic に配置しましょう。
  6. 「Set page variable」を配置したら一旦Logic のコンポーネントをそれぞれつなげます。これで値を「Get record collection」から引き継げるようになります。
  7. それでは「Set page variable」の値の設定を行いましょう。「Assigned value」のボタンをクリックし、
  8. 「Mapping」を選択します。
  9. デフォルトでは以下のような画面になっているので「no value」のボタンをクリックし、
  10. 「Output value of another node」をクリック。
  11. 前のLogic から引き継いだ「Get record collection」を選択します。
  12. これでMapping が行えるようになります。
  13. ドラッグアンドドロップで取得したデータと変数をマッピングしましょう。ここで予め変数をList とObject 形式で構成していたことが活きてきます。

実行してみる

それでは作成したアプリを実際に動かしてみましょう。

  1. 「LAUNCH」タブから「Open App Preview Portal」をクリックします。
  2. 以下のようにアプリ一覧画面が立ち上がるので「CDataSample」をクリックします。
  3. すると、Bitbucket からCData Connect Server 経由でデータを取得してきて、一覧表示を行った画面が表示されます。

このように、CData Connect Server を経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをSAP Build Apps で開発できます。他にも多くのデータソースに対応するCData Connect Server の詳細を、こちらからご覧ください。

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。