コラボフローのクラウド申請フォームでSingleStore のデータをLookup 参照する
コラボフロー（www.collabo-style.co.jp/ ）は誰でも簡単に作れるクラウドベースのワークフローサービスです。コラボフローでは、申請フォームにJavaScriptを組み込むことで、外部のREST APIをコールして入力補完や連携を行うことができる機能を提供しています。この記事では、SingleStore のデータをCData API Server 経由でコラボフローの申請書入力画面から参照できるようにします。このLookup 参照により、申請フォームの入力を便利にすることができます。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSingleStore OData サービスを作成していきましょう。
SingleStore への接続
コラボフロー からSingleStore のデータを操作するには、まずSingleStore への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SingleStore」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SingleStore への接続設定を行っていきましょう！
-
データに接続するには、次の接続プロパティが必要です。
- Server：SingleStore データベースをホスティングしているサーバーのホスト名またはIP アドレス。
- Port：SingleStore データベースをホスティングしているサーバーのポート。
また、オプションで以下を設定することもできます。
- SingleStore：SingleStore Server に接続する場合のデフォルトデータベース。設定されていない場合、すべてのデータベースのテーブルが返されます。
標準認証
標準認証で認証するには、次を設定します。
- User：SingleStore サーバーに認証する際に使われるユーザー。
- Password：SingleStore サーバーに認証する際に使われるパスワード。
統合セキュリティを使用した接続
標準のユーザー名とパスワードを提供する代わりに、Windows 認証を介して信頼されたされたユーザーをサーバーに認証できます。
SSL 認証
SSL 認証を活用してセキュアなセッションを介してSingleStore データに接続できます。次の接続プロパティを設定し、データに接続します。
- SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
- SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
- SSLClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
- SSLClientCertType：クライアントストアの証明書タイプ。
- SSLServerCert：サーバーが受け入れ可能な証明書。
SSH 認証
SSH を使用して、セキュアにリモートマシンにログインできます。SingleStore データにSSH 経由でアクセスするには、次の接続プロパティを設定します。
- SSHClientCert：クライアント証明書のための証明書ストア名に設定。
- SSHClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
- SSHClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
- SSHClientCertType：クライアントストアの証明書タイプ。
- SSHPassword：SSH サーバーに認証するためのパスワード。
- SSHPort：SSH 操作に使用するポート。
- SSHServer：認証しようとしているSSH 認証サーバー。
- SSHServerFingerPrint：接続先のホストの検証に使用するSSH サーバーのフィンガープリント。
- SSHUser：SSH サーバーに認証するためのユーザー名。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
データに接続するには、次の接続プロパティが必要です。
- Server：SingleStore データベースをホスティングしているサーバーのホスト名またはIP アドレス。
- Port：SingleStore データベースをホスティングしているサーバーのポート。
また、オプションで以下を設定することもできます。
- SingleStore：SingleStore Server に接続する場合のデフォルトデータベース。設定されていない場合、すべてのデータベースのテーブルが返されます。
標準認証
標準認証で認証するには、次を設定します。
- User：SingleStore サーバーに認証する際に使われるユーザー。
- Password：SingleStore サーバーに認証する際に使われるパスワード。
統合セキュリティを使用した接続
標準のユーザー名とパスワードを提供する代わりに、Windows 認証を介して信頼されたされたユーザーをサーバーに認証できます。
SSL 認証
SSL 認証を活用してセキュアなセッションを介してSingleStore データに接続できます。次の接続プロパティを設定し、データに接続します。
- SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
- SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
- SSLClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
- SSLClientCertType：クライアントストアの証明書タイプ。
- SSLServerCert：サーバーが受け入れ可能な証明書。
SSH 認証
SSH を使用して、セキュアにリモートマシンにログインできます。SingleStore データにSSH 経由でアクセスするには、次の接続プロパティを設定します。
- SSHClientCert：クライアント証明書のための証明書ストア名に設定。
- SSHClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
- SSHClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
- SSHClientCertType：クライアントストアの証明書タイプ。
- SSHPassword：SSH サーバーに認証するためのパスワード。
- SSHPort：SSH 操作に使用するポート。
- SSHServer：認証しようとしているSSH 認証サーバー。
- SSHServerFingerPrint：接続先のホストの検証に使用するSSH サーバーのフィンガープリント。
- SSHUser：SSH サーバーに認証するためのユーザー名。
API Server のユーザー設定
次に、API Server 経由でSingleStore にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SingleStore 用のAPI エンドポイントの作成
ユーザーを作成したら、SingleStore のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSingleStore への接続を設定してユーザーを作成し、API Server でSingleStore データのAPI を追加しました。これで、OData 形式のSingleStore データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
コラボフローで、SingleStore のデータに連携する
コラボフローから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 : 'singlestore_column',
// Key Column Name for API Server resource
ApiListupKeyColumn : 'singlestore_keycolumn',
// Mapping between Collaboflow field and API Server column
Mappings: [
{
PartsName: 'fid1', // Collabo flow field name
APIName: 'singlestore_column1' // API Server column name
},
{
PartsName: 'fid2',
APIName: 'singlestore_column2'
},
{
PartsName: 'fid3',
APIName: 'singlestore_column3'
},
{
PartsName: 'fid4',
APIName: 'singlestore_column4'
}
]
};
const CDataAPIServerSetting = {
// API Server URL
ApiServerUrl : 'http://XXXXXX',
// API Server Resource Name
ApiServerResourceName : 'singlestore_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 経由でSingleStore のデータを取得し、自動入力補完する機能がコラボフローの申請フォームに追加できました。
まとめと30日の無償評価版のご案内
このように SingleStore 内のデータをコラボフローで利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、コラボフローからのデータ参照を体感ください。