ODBC Driver for Workday

Build 22.0.8479

Linux DSN の構成

このセクションでは、以下のいくつかのLinux ディストリビューションでODBC 接続をセットアップしDSN を設定する方法を説明します:Ubuntu のようなDebian ベースのシステム、Red Hat Enterprise Linux (RHEL)、CentOS、およびFedora のようなRed Hat Linux プラットフォーム。

Linux の最小バージョン

Red Hat ベースおよびDebian ベースシステムでサポートされる最小バージョンは以下のとおりです。

OSMin. Version
Ubuntu11.04
Debian7
RHEL6.9
CentOS6.9
Fedora13
SUSE12.1

ドライバー依存関係のインストール

必要な依存関係をインストールするには、次のコマンドをルートとしてまたはsudo で実行します。

  • Debian/Ubuntu:
    apt-get install libc6 libstdc++6 zlib1g libgcc1
  • RHEL/CentOS/Fedora:
    yum install glibc libstdc++ zlib libgcc

本製品 が必要とする対応ライブラリは以下のとおりです。

Debian/Ubuntu PackageRHEL/CentOS/Fedora PackageFile
libc6glibclinux-vdso.1
libc6glibclibm.so.6
libc6glibclibrt.so.1
libc6glibclibdl.so.2
libc6glibclibpthread.so.0
libc6glibclibc.so.6
libc6glibcld-linux-x86-64.so.2
libstdc++6libstdc++libstdc++.so.6
zlib1gzliblibz.so.1
libgcc1libgcclibgcc_s.so.1

ドライバーのインストール

標準のパッケージ管理システムを使用してドライバーをインストールできます。

Ubuntu のようなDebian ベースのシステムでは、次のコマンドをroot またはsudo で実行します。

dpkg -i /path/to/driver/setup/WorkdayODBCDriverforUnix.deb 

RPM パッケージ形式をサポートするシステムでは、次のコマンドをroot またはsudo で実行します。

rpm -ivh /path/to/driver/WorkdayODBCDriverforUnix.rpm 

ドライバーのライセンス

次のコマンドを実行して本製品 のライセンスを取得します。評価版をアクティベートするには、<key> の入力を省略してください。

cd /opt/cdata/cdata-odbc-driver-for-workday/bin/
sudo ./install-license.sh <key>

ドライバーマネージャー経由の接続

ドライバーマネージャーはドライバーをロードし、アプリケーションからドライバーに関数呼び出しを渡します。本製品 をドライバーマネージャーに登録して、ドライバーマネージャーのコンフィギュレーションファイルにDSN を定義する必要があります。

本製品 のインストールでは、本製品 をunixODBC ドライバーマネージャーに登録し、システムDSN を作成します。UnixODBC ドライバーマネージャーは、Python やその他多くのアプリケーションから使用できます。アプリケーションに別のドライバーマネージャーが組み込まれている可能性があります。

DSN の作成

unixODBC をインストールしてDSN を設定するには、unixODBC の使用 を参照してください。OBIEE、Informatica、およびSAS に接続するDSN を作成するには、DataDirect ドライバーマネージャーの使用 を参照してください。

Connecting to the Workday WQL API

The WQL service must be enabled before connecting:

  1. Open Workday and enter View Domain in the search bar. Enter Workday Query Language for the prompt.
  2. Check that one of the Allowed Security Group Types includes the user you are connecting with.

Configuring the Host and Tenant

To obtain the Host and Tenant properties, log into Workday and search for View API Clients. On this screen, Workday will display the Workday REST API Endpoint which contains both the Host and Tenant. The Tenant is the portion after the last slash, while the Host is the "https://" and the domain name.

For example: if the API endpoint is https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the Host is https://wd3-impl-services1.workday.com and the Tenant is mycompany.

You also have the option of connecting to reports when the UseWQL property is enabled. See データアクセスのファインチューニング for details on how to configure this.

Authenticating to Workday

You can authenticate to the Workday WQL API as a normal (non-ISU) user, or an ISU (via either OAuth or OAuthJWT).

Normal User

To authenticate as a normal user in Workday, you must first create an API Client. Please refer to カスタムOAuth アプリケーションの作成 for details on the procedure.

Once you have an API client configured, set the following properties to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: The Client ID obtained from the View API Client page.
  • OAuthClientSecret: The Client Secret obtained from the View API Client page. If you are using a public client, leave this blank.
  • Tenant: The tenant for the account.
  • Host: The host for the REST API Endpoint in the View API Clients page.

ISU

To authenticate as an ISU, you must first create either an API Client or an API Client for Integrations. Please refer to カスタムOAuth アプリケーションの作成 for details on the procedure. You can create either an API Client for Integrations or an API Client using the JWT bearer grant type.

If you created an API Client for Integrations, set the following properties to connect:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: The Client ID obtained from the View API Client page.
  • OAuthClientSecret: The Client Secret obtained from the View API Client page.
  • OAuthRefreshToken: The refresh token obtained from the Manage Refresh Tokens for Integrations page.
  • Tenant: The tenant for the account.
  • Host: The host for the REST API Endpoint in the View API Clients page.

If you created an API Client with JWT, set the following properties to connect:

  • AuthScheme: Set this to OAuthJWT.
  • OAuthJWTCertType: Set this to the certificate type. This will be PFXFILE if you created the certificate with keytool or openssl pkcs12.
  • OAuthJWTCert: The path of the certificate file you created.
  • OAuthJWTCertPassword: The password of the certificate file you created.
  • OAuthJWTIssuer: The Client ID obtained from the View API Client page.
  • OAuthJWTSubject: The username of the ISU you are using.
  • Tenant: The tenant for the account.
  • Host: The host for the REST API Endpoint in the View API Clients page.

Connecting to the Workday SOAP API

Connections using the SOAP API support all the same authentication schemes that the WQL and reporting services do, in addition to basic authentication. Each of the above configurations can be used with SOAP by setting the UseWQL property to false.

Basic authentication can also be used with a normal user or an ISU without configuring an API client:

  • UseWQL: Set this to false.
  • AuthScheme: Set this to Basic.
  • User: The Workday user account name.
  • Password: The password used to authenticate the user.
  • Tenant: The tenant for the account.
  • Host: The host for the REST API Endpoint in the View API Clients page.

Other authentication methods are configured the same way as for the WQL and reporting services. Please refer to the corresponding sections for more details on those authentication schemes as well as the Host and Tenant properties.

OAuth 値のリフレッシュ

本製品 は、ブラウザベースのOAuth 認証交換中に取得されたテンポラリーOAuth アクセストークンをリフレッシュできます。デフォルトでは、本製品 は暗号化されたトークンを、DSN に対応するodbc.ini ファイルに保存します。System DSN の場合、このodbc.ini ファイルへのアクセスを制限できます。

トークンの自動交換を有効にするには、本製品 にシステムodbc.ini への書き込みアクセス権を与えます。

OAuth 認証の依存関係のインストール

OAuth 認証標準は、認証するユーザーにWeb ブラウザを使用したWorkday との通信を要求します。最初のOAuth インタラクションがドライバーがインストールされている同じマシン上で行われる場合(例えばデスクトップアプリケーションの場合)、本製品 はデフォルトブラウザを立ち上げるxdg-open プログラムにアクセスする必要があります。

この依存関係を満たすには、パッケージマネージャーに対応するパッケージをインストールします。

Debian/Ubuntu PackageRHEL/CentOS/Fedora PackageFile
xdg-utilsxdg-utilsxdg-open

ドライバーエンコーディングの設定

ODBC ドライバーは、ODBC ドライバーマネージャーで使用するエンコーディングを指定する必要があります。デフォルトでは、Unix 用のCData ODBC ドライバーはunixODBC と互換性のあるUTF-16 を使用するように設定されていますが、他のドライバーマネージャーでは代替エンコーディングが必要な場合があります。

また、ANSI ODBC API を使用するアプリケーションからODBC ドライバーを使用している場合は、ANSI コードページを設定する必要があります。例えば、ANSI アプリケーションに日本語の文字をインポートするには、設定ファイル'/opt/cdata/cdata-odbc-driver-for-workday/lib/cdata.odbc.workday.ini' でコードページを指定できます。

[Driver]
AnsiCodePage = 932

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479