コラボフローのクラウド申請フォームでDynamics CRM のデータをLookup 参照する
コラボフロー（www.collabo-style.co.jp/ ）は誰でも簡単に作れるクラウドベースのワークフローサービスです。コラボフローでは、申請フォームにJavaScriptを組み込むことで、外部のREST APIをコールして入力補完や連携を行うことができる機能を提供しています。この記事では、Dynamics CRM のデータをCData API Server 経由でコラボフローの申請書入力画面から参照できるようにします。このLookup 参照により、申請フォームの入力を便利にすることができます。
Dynamics CRM データ連携について
CData は、Microsoft Dynamics CRM のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：
- Dynamics CRM 2011+ サービスおよび Dynamics CRM Online のデータの読み取りと書き込みができます。
- カスタマイズ可能なキャッシュと、インテリジェントなクエリ集約・分離により、Dynamics CRM のネイティブ機能を拡張できます。
- Azure Active Directory、Azure マネージド サービス ID 認証情報、クライアントシークレットまたは証明書を使用した Azure サービスプリンシパルなど、さまざまな方法で Dynamics CRM に安全に認証できます。
CData のお客様は、データをデータウェアハウスにレプリケートしたい場合（他のデータソースと併せて）や、Microsoft エコシステム内のお気に入りのデータツール（Power BI、Excel など）または外部ツール（Tableau、Looker など）からライブ Dynamics CRM データを分析したい場合など、さまざまな理由で当社の Dynamics CRM 接続ソリューションを使用しています。
はじめに
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなDynamics CRM OData サービスを作成していきましょう。
Dynamics CRM への接続
コラボフロー からDynamics CRM のデータを操作するには、まずDynamics CRM への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Dynamics CRM」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Dynamics CRM への接続設定を行っていきましょう！
-
Dynamics CRM 接続プロパティの取得・設定方法
Dynamics CRM では、インスタンスごとに接続文字列の設定が必要です。 Authentication セクションでは、有効なDynamics CRM のUser、Password の入力、およびDynamics CRM Server Organization root のURL を設定します。さらに、CRMVersion プロパティに、'CRM2011+' もしくは'CRMOnline' を設定します。IFD コンフィグレーションもサポートされていますので、InternetFacingDeployment をTRUE に設定してください。
また、Security Token Service（STS）、もしくはAD FS エンドポイントをSTSURL プロパティに設定することもできます。 この値はGetSTSUrl ストアドプロシージャで取得できます。 Office 365 ユーザーはデフォルトSTS URL にCRMVersion の設定だけで接続することができます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Dynamics CRM 接続プロパティの取得・設定方法
Dynamics CRM では、インスタンスごとに接続文字列の設定が必要です。 Authentication セクションでは、有効なDynamics CRM のUser、Password の入力、およびDynamics CRM Server Organization root のURL を設定します。さらに、CRMVersion プロパティに、'CRM2011+' もしくは'CRMOnline' を設定します。IFD コンフィグレーションもサポートされていますので、InternetFacingDeployment をTRUE に設定してください。
また、Security Token Service（STS）、もしくはAD FS エンドポイントをSTSURL プロパティに設定することもできます。 この値はGetSTSUrl ストアドプロシージャで取得できます。 Office 365 ユーザーはデフォルトSTS URL にCRMVersion の設定だけで接続することができます。
API Server のユーザー設定
次に、API Server 経由でDynamics CRM にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Dynamics CRM 用のAPI エンドポイントの作成
ユーザーを作成したら、Dynamics CRM のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でDynamics CRM への接続を設定してユーザーを作成し、API Server でDynamics CRM データのAPI を追加しました。これで、OData 形式のDynamics CRM データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
コラボフローで、Dynamics CRM のデータに連携する
コラボフローから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 : 'dynamicscrm_column',
// Key Column Name for API Server resource
ApiListupKeyColumn : 'dynamicscrm_keycolumn',
// Mapping between Collaboflow field and API Server column
Mappings: [
{
PartsName: 'fid1', // Collabo flow field name
APIName: 'dynamicscrm_column1' // API Server column name
},
{
PartsName: 'fid2',
APIName: 'dynamicscrm_column2'
},
{
PartsName: 'fid3',
APIName: 'dynamicscrm_column3'
},
{
PartsName: 'fid4',
APIName: 'dynamicscrm_column4'
}
]
};
const CDataAPIServerSetting = {
// API Server URL
ApiServerUrl : 'http://XXXXXX',
// API Server Resource Name
ApiServerResourceName : 'dynamicscrm_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 経由でDynamics CRM のデータを取得し、自動入力補完する機能がコラボフローの申請フォームに追加できました。
まとめと30日の無償評価版のご案内
このように Dynamics CRM 内のデータをコラボフローで利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、コラボフローからのデータ参照を体感ください。