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

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

クラウドワークフローのコラボフローで、 API Server 経由でZoho Recruit のデータをLookup 参照する方法

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

API Server の設定

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

Zoho Recruit への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zoho Recruit」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Zoho Recruit への接続設定を行っていきましょう！
ZohoRecruit への認証では、OAuth 標準を使って自分のデータに接続したり、他のユーザーが各自のデータに接続できるようにしたりできます。

OAuth 認証の設定

まず、ZohoRecruit に OAuth アプリケーションを登録する必要があります。登録するには、Zoho Developer Console に移動して、新しい Client（Server-based application）を追加し、有効な OAuth リダイレクト URL を設定します。OAuth アプリケーションには client id と client secret が割り当てられます。さらに、該当する Domain（.com、.eu、.in、.com.cn、または .jp）を設定する必要があります。デフォルトは .com です。

以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：アプリ設定で指定された client_id に設定します。
- OAuthClientSecret：アプリ設定で指定された client_secret に設定します。
- CallbackURL：アプリ設定で指定されたリダイレクト URI に設定します。
- Domain：ProfileSettings に設定して、ZohoRecruit アカウントのドメイン（例：.com、.eu、.in、.com.cn、.jp）を指定します。
接続文字列の例：
```
Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
```
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

ZohoRecruit への認証では、OAuth 標準を使って自分のデータに接続したり、他のユーザーが各自のデータに接続できるようにしたりできます。

OAuth 認証の設定

まず、ZohoRecruit に OAuth アプリケーションを登録する必要があります。登録するには、Zoho Developer Console に移動して、新しい Client（Server-based application）を追加し、有効な OAuth リダイレクト URL を設定します。OAuth アプリケーションには client id と client secret が割り当てられます。さらに、該当する Domain（.com、.eu、.in、.com.cn、または .jp）を設定する必要があります。デフォルトは .com です。

以下の接続プロパティを設定して接続を確立してください：

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定された client_id に設定します。
OAuthClientSecret：アプリ設定で指定された client_secret に設定します。
CallbackURL：アプリ設定で指定されたリダイレクト URI に設定します。
Domain：ProfileSettings に設定して、ZohoRecruit アカウントのドメイン（例：.com、.eu、.in、.com.cn、.jp）を指定します。

接続文字列の例：

Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

API Server のユーザー設定

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

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

Zoho Recruit 用のAPI エンドポイントの作成

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

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

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

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

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

コラボフローから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を作成したら、後はコラボフローにアップするだけです。

コラボフローにログインし「アプリ設定」→「フォーム設定」に移動します。

フォーム一覧から使用するフォームを選択します。

フォーム編集画面に移動後、「カスタマイズ」タブをクリックし、ファイルをアップロードから作成したJSファイルをアップロードし、保存します。

これでAPI Server 経由でZoho Recruit のデータを取得し、自動入力補完する機能がコラボフローの申請フォームに追加できました。

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

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

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

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

CData API Server

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

お問い合わせ

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

API Server の設定

Zoho Recruit への接続

OAuth 認証の設定

接続文字列の例：

OAuth 認証の設定

接続文字列の例：

API Server のユーザー設定

Zoho Recruit 用のAPI エンドポイントの作成

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

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

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

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

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

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

この記事の内容

関連記事