コラボフローでUKG Pro HCM のデータと連携したワークフローを作成

杉本和也
杉本和也
リードエンジニア
クラウドワークフローのコラボフローで、UKG Pro HCM のデータと連携したワークフローを作成

コラボフロー(www.collabo-style.co.jp/ )は誰でも簡単に作れるクラウドベースのワークフローサービスです。さらにCData Connect AI と連携することで、UKG Pro HCM のデータへのクラウドベースのアクセスをノーコードで追加できます。本記事では、CData Connect AI 経由でコラボフローからUKG Pro HCM 連携を実現する方法を紹介します。

CData Connect AI はUKG Pro HCM のデータへのクラウドベースのOData インターフェースを提供し、コラボフローからUKG Pro HCM のデータへのリアルタイム連携を実現します。

Connect AI を構成

コラボフローでUKG Pro HCM のデータを操作するには、Connect AI からUKG Pro HCM に接続し、コネクションにユーザーアクセスを提供してUKG Pro HCM のデータのOData エンドポイントを作成する必要があります。

UKG Pro HCM に接続したら、目的のテーブルのOData エンドポイントを作成します。

パーソナルアクセストークン(PAT)の追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

  1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
  2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
  3. PAT の名前を入力して Create をクリックします。 Creating a new PAT
  4. パーソナルアクセストークン(PAT)は作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からUKG Pro HCM に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「UKG Pro HCM」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、UKG Pro HCM に接続します。

    まず、Profile 接続プロパティをディスク上の UKGProHCM プロファイルの場所に設定します(例:C:\profiles\UKGProHCM.apip)。次に、ProfileSettings 接続プロパティを UKGProHCM の接続文字列に設定します(以下を参照)。

    UKGProHCM API プロファイル設定

    UKG Pro HCM では、Basic 認証とカスタマー API キーを組み合わせて API へのアクセスを認可します。接続には、UKG Pro HCM の認証情報と、UKG が発行したカスタマー API キーが必要です。

    認証するには、以下の接続プロパティを設定します。

    • AuthScheme:Basic に設定します。
    • User:UKG Pro HCM のユーザー名に設定します。
    • Password:UKG Pro HCM のパスワードに設定します。
    • ProfileSettings:以下の項目をセミコロン区切りで指定します。
      • Host:UKG Pro HCM テナントのホスト名(例:yourcompany.ultipro.com)。
      • CustomerAPIKey:UKG のカスタマー API キー。各 API 呼び出しで US-CUSTOMER-API-KEY リクエストヘッダーとして渡されます。

    カスタマー API キーの入手方法については、UKG Pro HCM の管理者にお問い合わせいただくか、UKG Developer Portal(https://developer.ukg.com)をご参照ください。

    接続の設定(Salesforce の表示)
  4. Create & Test をクリックします。
  5. 「Add UKG Pro HCM Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

Connect AI にUKG Pro HCM OData エンドポイントを追加する

UKG Pro HCM に接続したら、目的のテーブルのOData エンドポイントを作成します。

  1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
  2. UKG Pro HCM 接続(例:API1)を選択し、Next をクリックします。
  3. 使用するテーブルを選択し、「Confirm」をクリックします。 テーブルを選択(Salesforce の例)

コネクションとOData エンドポイントを設定したら、コラボフローからUKG Pro HCM のデータに接続できます。

UKG Pro HCM のデータに接続したワークフローを作成

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

コラボフロー上で使用するConnect AI との接続用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 Connect AI
            ApiListupFiledColumn : 'api_column',

            // Key Column Name for Connect AI resource
            ApiListupKeyColumn : 'api_keycolumn',

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

        const CDataConnectCloudSetting = {
            // Connect AI URL
            ConnectCloudUrl : 'http://XXXXXX',

            // Connect AI Resource Name
            ConnectCloudResourceName : 'api_table',

            // Connect AI Key
            Headers : { Authorization: 'Basic YOUR_BASIC_AUTHENTICATION' },

            // General Properties
            ParseType : 'json',

            get BaseUrl() {
                return CDataCloudServerSetting.ApiServerUrl + '/api.rsc/' + CDataCloudServerSetting.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 Connect AI, 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(
                CDataCloudServerSetting.BaseUrl + '?' +
                queryParam +
                topParam,
                CDataCloudServerSetting.Headers,
                CDataCloudServerSetting.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);
            });
        }
    })();
  • 「CDataConnectCloudSetting」のそれぞれのプロパティには構成したSSH Server のURL とConnect AI の認証情報をそれぞれ設定してください。
  • 「AutocompleteSetting」はどのフィールドでオートコンプリートを動作させるか? といった設定と、API のプロパティとのマッピングを行います。
  • 今回はコラボフローのデフォルトテンプレートで提供されている「12a.見積書・注文書」で利用しますので、デフォルトでは商品名のフィールドを、Product テーブルのName と紐付けて、Autocomplete を行うように構成しています。値が決定されたら、Key となるProductID を元に「型番、標準単価、仕入単価、御提供単価」をそれぞれAPI から取得した値で自動補完するようになっています。

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

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

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

クラウドアプリケーションからUKG Pro HCM のデータへのライブ接続

コラボフローからUKG Pro HCM のリアルタイムデータに直接接続できるようになりました。これで、UKG Pro HCM のデータを複製せずにより多くの接続とアプリを作成できます。

クラウドアプリケーションから直接350を超えるSaaS 、ビッグデータ、NoSQL ソースへのリアルタイムデータアクセスを取得するには、CData Connect AI を参照してください。

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

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル