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

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

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

※製品について詳しい情報をご希望の方は以下からお進みください。

QuickBooks POS にほかのBI、ETL、開発ツールから接続したい：QuickBooks POS データ連携ガイドおよびチュートリアルのリストへ
API Server について詳細を知りたい：API Serverページへ
ほかのデータソースに連携したい：CData Drivers 一覧へ
ドライバーの30日の無償トライアル版を使いたい：トライアル版ダウンロードページへ
製品の利用やライセンスについて相談したい：sales@cdata.co.jp までメールにてご相談ください。

API Server の設定

次のステップに従い、セキュアな REST API サービスを立ち上げます。

デプロイ

API Server はサーバー上で稼働します。Windows 版は、製品に組み込まれているスタンドアロンのサーバーかIIS に配置して稼働させることができます。Java 版では、Java servlet コンテナにAPI Server のWAR ファイルを配置します。デプロイの詳細は製品ヘルプを参照してください。API Server を Microsoft Azure、 Amazon EC2、Heroku にデプロイする方法はKB に記事があります。

QuickBooks POS への接続

API Server の管理コンソールで［設定］→［接続］から新しい接続を追加します。

QuickBooks POS のアイコンがデフォルトのAPI Server の接続先にない場合には、API Server がJava 版の場合はJDBC Drivers、API Server がWindows 版の場合はADO.NET Data ProvidersからQuickBooks POS ドライバーをAPI Server と同じマシンにインストールして、API Server を再起動します。
QuickBooks POS への接続に必要な認証情報を入力します。接続のテストを行い、接続を確認して、設定を保存します。
ローカルQuickBooks インスタンスに接続する場合は、接続プロパティを設定する必要はありません。

本製品はリモートコネクタ経由でQuickBooks にリクエストを作成します。リモートコネクタはQuickBooks POS と同じマシン上で動作し、軽量の組み込みWeb サーバーを介して接続を受け入れます。サーバーはSSL/TLS をサポートし、ユーザーにリモートマシンからのセキュアな接続を可能にします。

初めて接続するときは、リモートコネクタをQuickBooks POS で認可する必要があります。詳細はヘルプドキュメントの「はじめに」を参照してください。

接続を確立後、［設定］→［リソース］の画面でテーブル一覧からREST API として公開するエンティティを選択します。

API Server のユーザー設定

［設定］→［ユーザー］からAPI にアクセスできるユーザーの認証設定を行います。API Server はトークンでの認証を行うことができます。 IP アドレスでAPI へのアクセスを制限することも可能です。デフォルトではローカルマシンからのアクセスのみが許可されています。SSL の設定も可能です。

コラボフローで、QuickBooks POS データに連携する

コラボフローから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 : 'quickbookspos_column',
    
            // Key Column Name for API Server resource 
            ApiListupKeyColumn : 'quickbookspos_keycolumn',
    
            // Mapping between Collaboflow field and API Server column
            Mappings: [
                {
                    PartsName: 'fid1', // Collabo flow field name
                    APIName: 'quickbookspos_column1' // API Server column name
                },
                {
                    PartsName: 'fid2', 
                    APIName: 'quickbookspos_column2'
                },
                {
                    PartsName: 'fid3', 
                    APIName: 'quickbookspos_column3'
                },
                {
                    PartsName: 'fid4', 
                    APIName: 'quickbookspos_column4'
                }
            ]
        };
    
        const CDataAPIServerSetting = {
            // API Server URL
            ApiServerUrl : 'http://XXXXXX',
    
            // API Server Resource Name
            ApiServerResourceName : 'quickbookspos_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 経由でQuickBooks POS データを取得し、自動入力補完する機能がコラボフローの申請フォームに追加できました。

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

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