コラボフローのクラウド申請フォームでGoogle Translate のデータをLookup 参照する

杉本和也
杉本和也
リードエンジニア
クラウドワークフローのコラボフローで、 API Server 経由でGoogle Translate のデータをLookup 参照する方法



コラボフロー(www.collabo-style.co.jp/ )は誰でも簡単に作れるクラウドベースのワークフローサービスです。コラボフローでは、申請フォームにJavaScriptを組み込むことで、外部のREST APIをコールして入力補完や連携を行うことができる機能を提供しています。この記事では、Google Translate のデータをCData API Server 経由でコラボフローの申請書入力画面から参照できるようにします。このLookup 参照により、申請フォームの入力を便利にすることができます。

API Server の設定

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

Google Translate への接続

コラボフロー からGoogle Translate のデータを操作するには、まずGoogle Translate への接続を作成・設定します。

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

    Google Cloud Translation API では、翻訳サービス、データセット、用語集、適応型 MT リソースへの安全なアクセスを確保するために、OAuth 2.0 認証が必要です。この認証方式により、Google Cloud プロジェクトに安全に接続し、適切な認可のもとで翻訳リソースを管理できます。

    OAuth 2.0 のセットアップと設定

    ステップ 1:Google Cloud プロジェクトの作成と API の有効化

    OAuth 認証をセットアップするには、以下のステップで進めます:

    1. Google Cloud Console にアクセスします
    2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します
    3. Project ID を控えておきます(すべての API 呼び出しで必要です)
    4. 「APIs & Services」 > 「Library」に移動します
    5. 「Cloud Translation API」を検索して有効化します
    6. 「APIs & Services」 > 「Credentials」に移動します
    7. 「Create Credentials」をクリックし、「OAuth Client ID」を選択します
    8. プロンプトが表示されたら OAuth 同意画面を設定します
    9. 用途に応じて「Desktop application」または「Web application」を選択します
    10. 承認済みリダイレクト URI(CallbackURL)を設定します
    11. 接続で使用する Client ID と Client Secret をコピーします

    必須の接続プロパティ

    • AuthScheme:OAuth に設定します(必須)
    • OAuthClientId:Google Cloud Console の Client ID(必須)
    • OAuthClientSecret:Google Cloud Console の Client Secret(必須)
    • CallbackURL:OAuth アプリケーションで指定したリダイレクト URI(必須)
    • InitiateOAuth:トークンを自動管理するには GETANDREFRESH に設定します(推奨)
    • ProjectId:Google Cloud のプロジェクト ID またはプロジェクト番号(クエリに必須)

    必須の OAuth スコープ

    Google Cloud Translation API プロファイルでは、以下の OAuth スコープが必要です:

    • https://www.googleapis.com/auth/cloud-translation - 翻訳、データセット、用語集、適応型 MT を含む Cloud Translation API リソースへのフルアクセス
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

認証

Google Cloud Translation API では、翻訳サービス、データセット、用語集、適応型 MT リソースへの安全なアクセスを確保するために、OAuth 2.0 認証が必要です。この認証方式により、Google Cloud プロジェクトに安全に接続し、適切な認可のもとで翻訳リソースを管理できます。

OAuth 2.0 のセットアップと設定

ステップ 1:Google Cloud プロジェクトの作成と API の有効化

OAuth 認証をセットアップするには、以下のステップで進めます:

  1. Google Cloud Console にアクセスします
  2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します
  3. Project ID を控えておきます(すべての API 呼び出しで必要です)
  4. 「APIs & Services」 > 「Library」に移動します
  5. 「Cloud Translation API」を検索して有効化します
  6. 「APIs & Services」 > 「Credentials」に移動します
  7. 「Create Credentials」をクリックし、「OAuth Client ID」を選択します
  8. プロンプトが表示されたら OAuth 同意画面を設定します
  9. 用途に応じて「Desktop application」または「Web application」を選択します
  10. 承認済みリダイレクト URI(CallbackURL)を設定します
  11. 接続で使用する Client ID と Client Secret をコピーします

必須の接続プロパティ

  • AuthScheme:OAuth に設定します(必須)
  • OAuthClientId:Google Cloud Console の Client ID(必須)
  • OAuthClientSecret:Google Cloud Console の Client Secret(必須)
  • CallbackURL:OAuth アプリケーションで指定したリダイレクト URI(必須)
  • InitiateOAuth:トークンを自動管理するには GETANDREFRESH に設定します(推奨)
  • ProjectId:Google Cloud のプロジェクト ID またはプロジェクト番号(クエリに必須)

必須の OAuth スコープ

Google Cloud Translation API プロファイルでは、以下の OAuth スコープが必要です:

  • https://www.googleapis.com/auth/cloud-translation - 翻訳、データセット、用語集、適応型 MT を含む Cloud Translation API リソースへのフルアクセス

API Server のユーザー設定

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

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

Google Translate 用のAPI エンドポイントの作成

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

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

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

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

コラボフローで、Google Translate のデータに連携する

コラボフローからAPI Server に連携するためのJavaScript の準備

コラボフロー上で使用するAPI Server との接続用JavaScriptを準備します。

    (function () {
        'use strict';

        // Setting Propeties
        const AutocompleteSetting =
        {
            // Autocomplete target field for Collaboflow
            InputName: 'fid0',

            // Collaboflow item detils line number
            ListRowNumber : 15,

            // Autocomplete tartget field for API Server
            ApiListupFiledColumn : 'api_column',

            // Key Column Name for API Server resource
            ApiListupKeyColumn : 'api_keycolumn',

            // Mapping between Collaboflow field and API Server column
            Mappings: [
                {
                    PartsName: 'fid1', // Collabo flow field name
                    APIName: 'api_column1' // API Server column name
                },
                {
                    PartsName: 'fid2',
                    APIName: 'api_column2'
                },
                {
                    PartsName: 'fid3',
                    APIName: 'api_column3'
                },
                {
                    PartsName: 'fid4',
                    APIName: 'api_column4'
                }
            ]
        };

        const CDataAPIServerSetting = {
            // API Server URL
            ApiServerUrl : 'http://XXXXXX',

            // API Server Resource Name
            ApiServerResourceName : 'api_table',

            // API Server Key
            Headers : { Authorization: 'Basic YOUR_BASIC_AUTHENTICATION' },

            // General Properties
            ParseType : 'json',

            get BaseUrl() {
                return CDataAPIServerSetting.ApiServerUrl + '/api.rsc/' + CDataAPIServerSetting.ApiServerResourceName
            }
        }

        let results = [];
        let records = [];

        // Set autocomplete processing for target input field
        collaboflow.events.on('request.input.show', function (data) {
            for (let index = 1; index < AutocompleteSetting.ListRowNumber; index++) {
                $('#' + AutocompleteSetting.InputName + '_' + index).autocomplete({
                    source: AutocompleteDelegete,
                    autoFocus: true,
                    delay: 500,
                    minLength: 2
                });
            }
        });

        // This function get details from API Server, Then set values at each input fields based on mappings object.
        collaboflow.events.on('request.input.' + AutocompleteSetting.InputName + '.change', function (eventData) {
            debugger;

            let tartgetParts = eventData.parts.tbl_1.value[eventData.row_index - 1];

            let keyId = tartgetParts[AutocompleteSetting.InputName].value.split(':')[1\;
            let record = records.find(x => x[AutocompleteSetting.ApiListupKeyColumn] == keyId);

            if (!record)
                return;

            AutocompleteSetting.Mappings.forEach(x => tartgetParts[x.PartsName].value = '');
            AutocompleteSetting.Mappings.forEach(x => tartgetParts[x.PartsName].value = record[x.APIName]);
        });

        function AutocompleteDelegete(req, res) {
            let topParam = '&$top=10'
            let queryParam = '$filter=contains(' + AutocompleteSetting.ApiListupFiledColumn + ',\'' + encodeURIComponent(req.term) + '\')';
            collaboflow.proxy.get(
                CDataAPIServerSetting.BaseUrl + '?' +
                queryParam +
                topParam,
                CDataAPIServerSetting.Headers,
                CDataAPIServerSetting.ParseType).then(function (response) {
                results = [];
                records = [];

                if (response.body.value.length == 0) {
                    results.push('No Results')
                    res(results);
                    return;
                }

                records = response.body.value;
                records.forEach(x => results.push(x[AutocompleteSetting.ApiListupFiledColumn] + ':' + x[AutocompleteSetting.ApiListupKeyColumn]));
                res(results);
            }).catch(function (error) {
                alert(error);
            });
        }
    })();
  • 「CDataAPIServerSetting」のそれぞれのプロパティには構成したSSH ServerのURLとAPI Serverの認証情報をそれぞれ設定してください。
  • 「AutocompleteSetting」はどのフィールドでオートコンプリートを動作させるか? といった設定と、APIのプロパティとのマッピングを行います。
  • 今回はCollaboflowのデフォルトテンプレートで提供されている「12a.見積書・注文書」で利用しますので、デフォルトでは商品名のフィールドを、ProductテーブルのNameと紐付けて、Autocompleteを行うように構成しています。値が決定されたら、KeyとなるProductIDを元に「型番、標準単価、仕入単価、御提供単価」をそれぞれAPIから取得した値で自動補完するようになっています。

コラボフロー側でJavaScriptを登録

JavaScriptを作成したら、後はコラボフローにアップするだけです。

  • コラボフローにログインし「アプリ設定」→「フォーム設定」に移動します。
  • CollaboFlow
  • フォーム一覧から使用するフォームを選択します。
  • CollaboFlow
  • フォーム編集画面に移動後、「カスタマイズ」タブをクリックし、ファイルをアップロードから作成したJSファイルをアップロードし、保存します。
  • CollaboFlow
  • これでAPI Server 経由でGoogle Translate のデータを取得し、自動入力補完する機能がコラボフローの申請フォームに追加できました。

まとめと30日の無償評価版のご案内

このように Google Translate 内のデータをコラボフローで利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、コラボフローからのデータ参照を体感ください。

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

詳細はこちら、または無料トライアルにお申し込みください:

CData API Server