MySQL HeatWave にWorkday のデータを統合する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Sync は、数百のSaaS / DB のデータをMySQL HeatWave をはじめとする各種DB / データウェアハウスにノーコードで統合・レプリケーション（複製）が可能なETL / ELT ツールです。本記事では、Workday のデータをCData Sync を使ってOracle Cloud Infrastructure（OCI）上のMySQL HeatWave に統合するデータパイプラインを作っていきます。

CData Sync とは？

CData Sync は、レポーティング、アナリティクス、機械学習、AI などで使えるよう、社内のデータを一か所に統合して管理できるデータ基盤をノーコードで構築できるETL ツールで、以下の特徴を持っています。

1. Workday をはじめとする400種類以上のSaaS / DB データに対応
2. MySQL HeatWave など多くのレイクハウス、RDB、データレイク、データウェアハウスに同期可能
3. 業務データのデータ分析基盤へのETL / ELT 機能に特化し、極限まで設定操作をシンプルに
4. 主要なSaaS データの差分更新やCDC（Change Data Capture、変更データキャプチャ）のサポート
5. フレキシブルなSQL / dbt 連携での取得データの変換

CData Sync では、1. データソースとしてWorkday の接続を設定、2. 同期先としてMySQL HeatWave の接続を設定、3. Workday からMySQL HeatWave へのレプリケーションジョブの作成、という3つのステップだけでレプリケーション処理を作成可能です。以下に具体的な設定手順を説明します。

事前準備

本手順では、Oracle Cloud Infrastructure（以下、OCI）上にMySQL HeatWave、およびCData Sync を用いたデータパイプラインを構築します。構成は以下のとおりです。

MySQL HeatWave のインスタンスについては、事前に作成しているものとして進めていきます。未作成の場合は、OCI の記事を参考に作成してみてください。

それでは、OCI に接続に使用するLinux インスタンスを作ってみましょう。

外部からのアクセスポートはssh 接続のみ許容していて、予めssh キーのキー・ペアを生成しておき、秘密キーをダウンロードしています。

また、Linux 上のCData Sync へのアクセスにはOCI 上の仮想ファイアウォール、およびOS 上のファイアウォールの設定が必要になります。設定には、スマートスタイル社のこちらの記事を参考にしていただけます。

次に、MySQL HeatWave に今回使用するテーブルを作成して、Linux インスタンスにCData Sync をインストールしていきます。

HeatWave インスタンスに今回使用するデータベースを作る

まずは、MySQL 上に今回Workday のデータを同期するテーブルを作っていきます。

最初に作成したLinux インスタンスに接続しましょう。各環境でのインスタンスへの接続方法はOCI の記事が参考になります。

yum install mysql などのコマンドでMySQL をインストールしたら、MySQL にHeatWave のプライベートIP アドレスを指定して接続します。

接続出来たら、以下のコマンドでテーブルを作成しましょう（例としてsync を使用）。

以下のコマンドを実行して、作成したテーブルが含まれていればOKです。

Linux インスタンスにCData Sync をインストール

次に、クロスプラットフォーム版CData Sync をダウンロードして、Linux インスタンスにscp コマンドなどでコピーしておきましょう。

Sync はこちらのページから30日間無償トライアルがダウンロードできますので、お気軽にお試しください。

インスタンスにssh 接続してCData Sync をインストールしていきます。

コピーしておいたCDataSync.tar.gz ファイルをtar コマンドで任意のディレクトリに展開します。

それでは、CData Sync を起動してみましょう！

CData Sync をインストールしたディレクトリに移動したら以下のコマンドを実行して、Sync を起動します。

以下のメッセージが表示されていれば、起動は成功です。

それでは、以下のアドレスにクライアントからアクセスして、Sync にアクセスしてみましょう。

以下のようなユーザー作成画面が表示されたら準備完了です！ユーザーを作成して、Sync にログインしてみましょう。

CData Sync のデータソースとしてWorkday の接続を設定

ユーザーを作成してCData Sync にログインしたら、データソースとしてWorkday を設定していきましょう。左の［接続］タブをクリックします。

1. ［＋接続の追加］ボタンをクリックします。
2. ［データソース］タブを選択して、リスト表示されるデータソースを選ぶか、検索バーにデータソース名を入力して、Workday を見つけます。
3. Workday の右側の［→］をクリックして、Workday アカウントへの接続画面を開きます。もし、Workday のコネクタがデフォルトでCData Sync にインストールされていない場合には、ダウンロードアイコン（コネクタのアップロードアイコン）をクリックし、［ダウンロード］をクリックすると、CData Sync にコネクタがインストールされます。
4. 接続プロパティにWorkday に接続するアカウント情報を入力をします。
   

   Workday 接続プロパティの取得・設定方法

   ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

   接続の前提条件

   API / 前提条件 / 接続パラメータ
   WQL / WQL サービスを有効化（下記参照） / ConnectionType： WQL
   Reports as a Service / カタログレポートの設定（ヘルプドキュメントの「データアクセスのファインチューニング」参照） / ConnectionType： Reports
   REST / 自動で有効化 / ConnectionType： REST
   SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

   BaseURL およびTenant の取得

   BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

   REST API Endpoint のフォーマットは、 https://domain.com/subdirectories/mycompany です。ここで、
   

   • https://domain.com/subdirectories/ はBaseURL です。
   • mycompany（URL の最後のスラッシュの後の部分）はTenant です。

   例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

   WQL サービスを有効化

   Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。
   1. Workday を開きます。
   2. 検索バーにView Domain と入力します。
   3. プロンプトにWorkday Query Language と入力します。
   4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

   Workday への認証

   Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。

   

5. ［作成およびテスト］をクリックして、正しくWorkday に接続できているかをテストして保存します。これでレプリケーションのデータソースとしてWorkday への接続が設定されました。

同期先としてMySQL HeatWave の接続を設定

次に、Workday のデータを書き込む先（＝同期先）として、MySQL HeatWave を設定します。同じく［接続］タブを開きましょう。

1. ［＋接続の追加］ボタンをクリックします。
2. ［同期先］タブを選択して、リスト表示されるデータソースを選ぶか、検索バーにデータソース名を入力して、「MySQL」を見つけます。今回接続するのはMySQL HeatWave ですが、Sync での接続ではMySQL を使用してOKです。
3. MySQL の右側の［→］をクリックして、MySQL HeatWave データベースへの接続画面を開きます。
4. 必要な接続プロパティを入力します。MySQL HeatWave との接続には、以下のプロパティが必要です:
   • Server: HeatWave のプライベートIP アドレス。
   • Port: サーバーのポート。デフォルトは3306
   • User: HeatWave 構成時に設定したユーザー名。
   • Password: HeatWave 構成時に設定したパスワード。
   • Database: 同期先のデータベース名（本記事ではsync を使用）。

   プライベートIPアドレスとポートについてはMySQL Heatwaveの接続タブから確認できます。

   
5. ［作成およびテスト］をクリックして、正しく接続できているかをテストします。
6. これで同期先としてMySQL HeatWave を設定できました。CData Sync では、MySQL HeatWave のデータベース名を指定するだけで、同期するWorkday に併せたテーブルスキーマを自動的にCREATE TABLE してくれます。同期データに合わせたテーブルを事前に作成するなどの面倒な手順は必要ありません。もちろん、既存テーブルにマッピングを行いデータ同期を行うことも可能です。

Workday からMySQL HeatWave へのレプリケーションジョブの作成

CData Sync では、レプリケーションをジョブ単位で設定します。ジョブは、Workday からMySQL という単位で設定し、複数のテーブルを含むことができます。レプリケーションジョブ設定には、［ジョブ］タブに進み、［＋ジョブを追加］ボタンをクリックします。

［ジョブを追加］画面が開き、以下を入力します。

1. 名前：ジョブの名前
2. データソース：ドロップダウンリストから先に設定したWorkday を選択
3. 同期先：先に設定したMySQL を選択

すべてのオブジェクトをレプリケーションする場合

Workday のすべてのオブジェクト / テーブルをレプリケーションするには、［種類］セクションで［すべて同期］を選択して、［タスクを追加］ボタンで確定します。

作成したジョブ画面で、右上の［▷実行］ボタンをクリックするだけで、全Workday テーブルのMySQL HeatWave への同期を行うことができます。

オブジェクトを選択してレプリケーションする場合

Workday から特定のオブジェクト / テーブルを選択してレプリケーションを行うことが可能です。［種類］セクションでは、［標準（個別設定）］を選んでください。

次に［ジョブ］画面で、［タスク］タブをクリックし、［タスクを追加］ボタンをクリックします。

するとCData Sync で利用可能なオブジェクト / テーブルのリストが表示されるので、レプリケーションを行うオブジェクトにチェックを付けます（複数選択可）。［タスクを追加］ボタンで確定します。

作成したジョブ画面で、［▷実行］ボタンをクリックして（もしくは各タスク毎の実行ボタンを押して）、レプリケーションジョブを実行します。

それでは、実際にHeatWave にWorkday のデータが同期されているかどうか、OCI インスタンス上のMySQL Shell で確認してみましょう。

Workers が同期されていますね！このように、とても簡単にWorkday からMySQL HeatWave への同期を行うことができました。

CData Sync の主要な機能を試してみる：スケジューリング・差分更新・ETL

ジョブのスケジュール起動設定

CData Sync では、同期ジョブを1日に1回や15分に1回などのスケジュール起動をすることができます。ジョブ画面の［概要］タブから［スケジュール］パネルを選び、［⚙設定］ボタンをクリックします。［間隔］と同期時間の［毎時何分］を設定し、［保存］を押して設定を完了します。これでCData Sync が同期ジョブをスケジュール実行してくれます。ユーザーはダッシュボードで同期ジョブの状態をチェックするだけです。

差分更新

CData Sync では、主要なデータソースでは、差分更新が可能です。差分更新では、最後のジョブ実行時からデータソース側でデータの追加・変更があったデータだけを同期するので、レプリケーションのクエリ・通信のコストを圧倒的に抑えることが可能です。

差分更新を有効化するには、ジョブの［概要］タブから「差分更新」パネルを選び、［⚙設定］ボタンをクリックします。［開始日］と［レプリケーション間隔］を設定して、［保存］します。

SQL での取得データのカスタマイズ

CData Sync は、デフォルトではWorkday のオブジェクト / テーブルをそのままMySQL HeatWave に複製しますが、ここにSQL、またはdbt 連携でのETL 処理を組み込むことができます。テーブルカラムが多すぎる場合や、データ管理の観点から一部のカラムだけをレプリケーションしたり、さらにデータの絞り込み（フィルタリング）をしたデータだけをレプリケーションすることが可能です。

ジョブの［概要］タブ、［タスク］タブへと進みます。選択されたタスク（テーブル）の［▶］の左側のメニューをクリックし、［編集］を選びます。タスクの編集画面が開きます。

UI からカラムを選択する場合には、［カラム］タブから［マッピング編集］をクリックします。レプリケーションで使用しないカラムからチェックを外します。

SQL を記述して、フィルタリングなどのカスタマイズを行うには、［クエリ］タブをクリックし、REPLICATE ［テーブル名］の後に標準SQL でフィルタリングを行います。

Workday からMySQL HeatWave へのデータ同期には、ぜひCData Sync をご利用ください

このようにノーコードで簡単にWorkday のデータをMySQL HeatWave にレプリケーションできます。データ分析、AI やノーコードツールからのデータ利用などさまざまな用途でCData Sync をご利用いただけます。30日の無償トライアルで、シンプルでパワフルなデータパイプラインを体感してください。

日本のユーザー向けにCData Sync は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

CData Sync の 導入事例を併せてご覧ください。