Axios と CData Connect AI で Workday に接続した Web アプリを構築
Axios は開発者が Web ブラウザや Node.js からサーバーに HTTP リクエストを送信できる JavaScript ライブラリです。CData Connect AI と組み合わせることで、Web アプリからライブWorkday のデータにアクセスできます。この記事では、Workday に接続し、Axios でライブWorkday のデータにアクセスできる Web アプリを構築する方法を説明します。
Workday データ連携について
CData は、Workday のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:
- Prism Analytics Data Catalog で作成したテーブルやデータセットにアクセスでき、Workday システムの忠実性を損なうことなく、ネイティブの Workday データハブを操作できます。
- Workday Reports-as-a-Service にアクセスして、Prism から利用できない部門データセットや、Prism の許容サイズを超えるデータセットのデータを表示できます。
- WQL、REST、または SOAP でベースデータオブジェクトにアクセスし、より詳細で細かいアクセスを実現できます(ただし、クエリの作成には Workday 管理者や IT の支援が必要な場合があります)。
ユーザーは、Tableau、Power BI、Excel などの分析ツールと Workday を統合し、当社のツールを活用して Workday データをデータベースやデータウェアハウスにレプリケートしています。アクセスは、認証されたユーザーの ID とロールに基づいて、ユーザーレベルで保護されます。
Workday を CData と連携させるための設定についての詳細は、ナレッジベース記事をご覧ください:Comprehensive Workday Connectivity through Workday WQL および Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices
はじめに
Axios から Workday に接続
Axios で Workday を操作するには、Connect AI から Workday に接続し、ユーザーにアクセス権を提供し、Workday のデータ 用のワークスペースを作成する必要があります。
Connect AI から Workday に接続
CData Connect AI はシンプルなポイントアンドクリックインターフェースでデータソースに接続できます。
- Connect AI にログインして「Sources」をクリック、次に「 Add Connection」をクリック
- 接続を追加パネルから「Workday」を選択
-
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/
/mycompany です。ここで、
- https://domain.com(URL のサブディレクトリと会社名の前の部分)は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 を有効にする必要があります。- Workday を開きます。
- 検索バーにView Domain と入力します。
- プロンプトにWorkday Query Language と入力します。
- Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。
Workday への認証
Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。
- 「Save & Test」をクリック
-
Workday 接続の追加ページで「Permissions」タブに移動し、ユーザーベースのアクセス許可を設定します。
Personal Access Token の作成
REST API、OData API、または Virtual SQL Server を介して Connect AI に接続する場合、Personal Access Token(PAT)を使用して Connect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別の PAT を作成することをお勧めします。
- Connect AI アプリの右上にある歯車アイコン()をクリックして設定ページを開きます。
- 設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
-
PAT に名前を付けて「Create」をクリックします。
- Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。
Axios 用に Workday エンドポイントを設定
Workday に接続したら、目的のテーブル用のワークスペースを作成します。
-
「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します(または既存のワークスペースを選択)。
- 「 Add」をクリックしてワークスペースに新しいアセットを追加します。
-
Workday 接続(例: Workday1)を選択して「Next」をクリックします。
-
操作するテーブルを選択して「Confirm」をクリックします。
- ワークスペースの OData サービス URL をメモしておきます(例: https://cloud.cdata.com/api/odata/{workspace_name})。
接続、PAT、ワークスペースが設定できたので、Axios からWorkday のデータに接続する準備が整いました。
Axios ワークフローで Workday のデータに接続
OData プロトコルを使用して Axios から CData Connect AI への接続を確立するには、以下のステップに従います。
- Web アプリ用のプロジェクトディレクトリを作成します(例: ~/connect_cloud/)
- ターミナルを開き、プロジェクトディレクトリに移動して以下のコマンドで node プロジェクトを初期化します:
npm init -y
- 以下のコマンドでプロジェクトに Axios 依存関係をインストールします:
npm install axios
プロジェクトディレクトリに以下のコードを含む server.js ファイルを作成します。CData Connect AI のユーザー名(例: [email protected])と PAT(前提条件で作成した PAT)を指定します。また、SELECT * FROM Workday1.SCHEMA.Workers のようなデータクエリも指定する必要があります。
server.js コード
const axios = require('axios') const user = '[email protected]' const pat = '***********************************'; //API エンドポイント const url = 'https://cloud.cdata.com/api/odata/{workspace_name}'; //POST リクエストで送信するデータ const data = { "query":"SELECT * FROM {workspace_name}.SCHEMA.Workers" }; axios.post(url, data, { auth: { username: user, password: pat } }) .then(response => { const rows = response.data.results[0].rows; const schema = response.data.results[0].schema; //カラム名の配列を作成 const columnNames = schema.map(col => col.columnName); //各行をループして、カラム名と値をログ出力 rows.forEach(row => { const rowObject = {}; row.forEach((value, index) => { const columnName = columnNames[index]; rowObject[columnName] = value; }); console.log(rowObject); }) }) .catch(error => { console.error('Error:', error); });- ターミナルで以下のコマンドを実行してサーバーを起動します:
node server.js
クエリ結果が表示されます:{ ID: 1, VALUE: -2 } { ID: 2, VALUE: 1 } { ID: 11, VALUE: null } { ID: 3, VALUE: 2 } { ID: 4, VALUE: 5 } ...
クラウドアプリケーションから Workday のデータへの簡易アクセス
これで、Axios からライブWorkday のデータへの直接接続が確立されました。Axios のようなクラウドアプリケーションから 100 以上の SaaS、ビッグデータ、NoSQL ソースへの簡易アクセスについての詳細は、Connect AI ページを参照してください。