Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Workday への接続を作成します。Workday アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからWorkday コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

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.

データアクセスのファインチューニング

SOAP API

When connecting with UseWQL disabled, the following properties will determine what tables are exposed:

• Service: A comma-separated list of Workday WSDLs to load. Each WSDL contains one schema which exposes multiple tables.
• WSDLURL: The URL to load a Workday WSDLs from. If provided, this will override Service and present WSDLs tables under the Workday schema.
• WSDLVersion: The version of the Workday API to load the WSDLs for. This can be used to request a newer or older version of the Workday data model.

Accessing Reports as a Service

When connecting with the UseWQL property enabled, the Sync App supports reading reports that have been exposed through Workday Reports as a Service (RaaS). Workday does not have a built-in way for the Sync App to determine which reports have been exposed via RaaS, so you must create a custom report to use this feature:

1. Open the Create Custom Report form.
2. Name the report Reports as a Service.
3. Enter Advanced for the report type.
4. Select Enable As Web Service.
5. Clear Optimized for Performance.
6. Enter All Custom Reports for the Data Source.

After the report is created, you need to add a few columns and filters:

1. In Fields
   • For the first column, enter Report Name.
   • Add a second colum and enter Web Service Namespace.
   • Add a third colum and enter Report Owner.
   • Add a fourth colum and enter Brief Description.
2. Make sure all columns have the primary business object as their Business Object. The primary business object has the name Custom Report and should have a box-and-arrow icon beside it. If the icon is an ellipsis (...) instead, then click menu , select Primary Business Object and then Custom Field.
3. Open the Filter tab and create a new filter. Enter Web Service Namespace as the field and is not blank as the Operator.
4. Add a second filter. Enter Current User as the field, in the selection list as the Operator, Value from Another Field as the comparison type, and Authorized Users as the comparison value.
5. Click OK to save the report. If Workday displays any warnings then click OK again to dismiss them.

Note that the Current User filter is optional but recommended. It is there to ensure that the Sync App does not surface reports that your account does not have permissions to view. However, if the report has performance issues then the filter can be removed.

The final step is to find the URL associated with the report. This URL is used to set the CustomReportURL connection property.

1. Open the newly created report.
2. Click the ellipsis (...) button beside the report title in the upper-left corner of the screen
3. Find the Web Services tab within the pop-up. You may have to scroll down inside the pop-up to see it.
4. Hover over it and select View URLs.
5. Copy the Workday XML link.

Troubleshooting

Invalid Request

While connecting, you may receive an error stating "Invalid Request". This is a server-side Workday error. It often indicates that your user account has not been granted the permissions required to either connect via the API, or to obtain the specific information you have requested.

The tables and columns are retrieved from a publicly available service that requires no authentication, so this error may appear while either testing the connection, or when trying to retrieve data after metadata has been obtained.

The Task Submitted is not Authorized

While connecting, you may receive an error stating "Processing error occurred. The task submitted is not authorized".

This is a server-side error Workday error. This error typically indicates that your Workday account does not have the necessary module activated to access the table or Service you are attempting to connect to.

Ensure the correct module is activated if you receive this error. The Sync App is unable to dynamically determine which modules are available at runtime, but the exposed services can be configured via the Service connection property.

このセクションでは、Workday Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Workday にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

WQL APIs

When UseWQL is enabled, the Sync App models Workday data sources as views. You can get a complete list of these data sources using the Data Sources standard report in Workday. The Sync App exposes each data source using its WQL Alias which is shown on the View Data Source page. All WQL data sources appear under the REST schema.

The Sync App does not list all the data sources defined within Workday:

1. The Sync App only exposes data sources that are accessible to the user you have authenticated as. For example, a user with only HR roles is able to view data sources containing employee records but not data sources about financial assets.
2. The Sync App only supports one data source filter per data source. The Sync App uses the unfiltered version of the data source when it is available. For data sources that require a data source filter, the Sync App automatically picks the first one listed on the data source. Different data source filters expose different prompts and may return different rows, but all return the same data fields.

You can use UseSplitTables to work around this limtiation by splitting each data source into multiple views with fewer columns.

Reports

When you enable UseWQL, the Sync App also grants access to reports that are exposed using Reports as a Service (RaaS). These reports are exposed as views within the Reports schema. Accessing these reports requires extra connection setup beyond the basic settings for WQL access. See データアクセスのファインチューニング for details on what is required.

The Sync App considers WQL views as higher priority than report views. If you write a query that does not specify a schema, the Sync App first tries to find a WQL data source with the name of the table. If it cannot find one then it tries to find a report with a title that matches the table name. Though in practice this kind of conflict is unlikely, as WQL data sources and report titles have different naming conventions.

SELECT * FROM [Possible Report Or Data Source]
/* Executed as SELECT * FROM REST.[Possible Report Or Data Source] 
   if there is both a report and WQL data source with this name */

Prompts

Many Workday data sources and reports have prompts that affect the output of the report. The Sync App exposes these prompts as input columns that have the _Prompt suffix. Most prompts accept only a single value, but prompts that accept multiple values can be set with IN or equals:

SELECT * FROM [Account Balance Data]
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'

Other filters may be included with prompts. These do not affect the way Workday generates the report, but the Sync App removes non-matching rows from the response:

SELECT * FROM [Account Balance Data]

/* Prompts */
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'

/* Other filters */
AND Department = 'Sales and Marketing'
AND Account_Type = 'LIABILITY'

SOAP APIs

The data models listed in Service are only available in the SOAP API. Accessing them requires disabling UseWQL.

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Workday Connector for CData Sync ビュー

Accesses the Allowance Plan as the primary object and returns one row per plan. Includes all allowance plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time.

Columns

Accesses the Bonus Plan as the primary object and returns one row per bonus plan. Includes all active bonus plans. Does not contain built-in prompts. The data source delivers the additions and removals for bonus plans over time.

Columns

Accesses the Compensation Plan as the primary object and returns one row per plan. Includes all active plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time.

Columns

Accesses the Compensation Rule as its primary object. The Compensation Rule object returns one row per Compensation Rule. Includes all Compensation Rules. Does not contain any built-in prompts.

Columns

Accesses Job Profile as the primary object and returns one row per job profile. Includes all active and inactive job profiles. Does not contain built-in prompts.

Columns

Accesses the Merit Plan as the primary object and returns one row per plan. Includes all active and inactive plans. Does not contain any built-in prompts. The data source delivers the additions and removals for plans over time.

Columns

Accesses the Position as its primary object. The Position object returns one row per position. Includes only open positions that are in supervisory organizations that the user has access. Does not contain any built-in prompts.

Columns

Accesses Pre-Hire as the primary object and returns one row per pre-hire. Includes all pre-hires as well as pre-hires converted to hires. Does not contain built-in prompts.

Columns

Accesses the Workday Account object and returns one row per Workday account. Includes all Workday accounts ever created, either currently enabled or not. Does not contain built-in prompts. This data source will show settings of the user login information and preferences in Workday.

Columns

Accesses the Worker as its primary object and returns one row per worker. Includes all workers even workers to be hired in the future. Does not contain any built-in prompts. This data source can be used to build reports on all workers. Helpful Tips - 1) If the worker is hired in the future, all fields will be returned based on the effective date. 2) If no effective date is specified, the system will use the current date as the effective date. 3) If the effective date is less than the worker's hire date, no effective dated information (such as position information, compensation information and so on) will be returned. 4) If effective dated behavior is desired, use the "All Active and Terminated workers" data source instead.

Columns

Returns all classes accessible by the current user

Columns

Accesses the Organization as its primary object. The Organization object returns one row per organization. Only includes supervisory organizations that the user manages. Prompts the user at run-time for Supervisory Organization to automatically filter the report results.

Columns

Accesses the Position Group as its primary object. The Position Group object returns one row per Position Group. Includes all unfilled and filled Positions. Prompts the user at run-time for a Compensation Rule to automatically filter the report results.

Columns

Accesses the Organization object and returns one row per organization. Includes all active and inactive organizations with no superior. Does not contain built-in prompts.

Columns

Accesses the Organization as its primary object. The Organization object returns one row per organization.

Columns

Authentication

OAuth

JWT OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

The type of authentication to use when connecting to Workday.

解説

The available authentication methods depend upon the service you are connecting to:

WQL and Reports as a Service

When connecting with UseWQL enabled, the following authentication schemes are available:

• OAuth: Use OAuth with a OAuthClientId and OAuthClientSecret. May be used with normal users or integration system users (ISUs). Normal users log into Workday interactively with a web browser, while the Sync App authenticates ISUs automatically.
• OAuthJWT: Use OAuth with an x509 certificate. Only available for ISUs.

SOAP

When connecting with UseWQL disabled, the following authentication schemes are available:

• Basic: Authenticate using the User and Password for a normal user or ISU.
• OAuth, OAuthJWT, AzureAD: These authentication schemes behave the same in WQL and Reports as a Service.

The tenant for the account.

解説

The tenant will be used when constructing the URL to use when attempting to retrieve data from Workday. For example:

https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources

In this example, "mycompany_gms1" would be the tenant.

The host for the API URL.

解説

The host will be used when constructing the APIURL. To obtain the Host, log into Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example:

https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany

In this case the Host is "https://wd3-impl-services1.workday.com".

Set to True to use Workday WQL REST API.

解説

Set to True to use Workday WQL REST API.

認証で使用されるWorkday ユーザーアカウント。

解説

このフィールドは、Password とともに、Workday サーバーに対して認証をするために使われます。

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

The specific SOAP service or services to retrieve data from. Enter as a comma seperated list.

解説

Combined with the WSDLVersion, the service determines which WSDLs may be used to dynamically obtain metadata from. Enter them as a comma seperated list, or leave this value blank to use all services the CData Sync App supports. The following values may be specified:

• Absence_Management
• Academic_Advising
• Academic_Foundation
• Admissions
• Adoption
• Benefits_Administration
• Campus_Engagement
• Cash_Management
• Compensation
• Compensation_Review
• Dynamic_Document_Generation
• Financial_Aid
• Financial_Management
• Human_Resources
• Identity_Management
• Integrations
• Inventory
• Learning
• Payroll
• Payroll_CAN
• Payroll_GBR
• Payroll_Interface
• Performance_Management
• Professional_Services_Automation
• Recruiting
• Resource_Management
• Revenue_Management
• Settlement_Services
• Staffing
• Student_Core
• Student_Finance
• Student_Recruiting
• Talent
• Tenant_Data_Translation
• Time_Tracking
• Workday_Connect
• Workday_Extensibility
• Workforce_Planning

Note that services come from the following: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html

The URL Of the report that shows all Reports as a Service (RaaS) reports.

解説

Workday does not have a built-in way of finding all the reports which can be used with RaaS. In order to discover these reports automatically, the Sync App uses a custom report that lists all reports enabled for RaaS.

See データアクセスのファインチューニング for instructions on how to create the report and retrieve its URL.

Whether to split WQL data sources into multiple tables.

解説

Workday data sources will often have several hundred fields, with some data sources like allWorkers having thousands of fields. Many database and reporting tools do not support tables with this many columns. By default the Sync App exposes the data sources the same way Workday does, so tools with these limitations cannot use larger data sources.

Enabling this option allows the Sync App to be used with these tools. When split tables are enabled, the Sync App creates multiple tables for complex Workday data sources. Each split table contains between 50-100 columns, along with the primary key, last modified timestamp and effective and entry inputs.

JOINs can be used if data is required from columns that are part of different split tables.

SELECT a.academicDegree, b.yearsExperience
FROM allWorkers_1 a INNER JOIN allWorkers_60 b
ON a.workdayID = b.workdayID

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。

解説

次のオプションが利用可能です。

1. OFF：OAuth フローが完全にユーザーにより操作されることを示します。認証にはOAuth アクセストークンが必要です。
2. GETANDREFRESH：OAuth フローが完全にSync App により操作されることを示します。現在トークンが存在しない場合にはブラウザを通じてユーザーをプロンプトすることで取得されます。トークンが存在する場合には必要に応じてリフレッシュされます。
3. REFRESH：Sync App がOAuthAccessToken のリフレッシュのみを操作することを示します。ユーザーはSync App によりブラウザを通じて認証することをプロンプトされることはありません。OAuthAccessToken とOAuthRefreshToken の最初の取得はユーザーが行う必要があります。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。

解説

OAuthRefreshToken プロパティは、OAuth 認証時にOAuthAccessToken のリフレッシュに使われます。

OAuth アクセストークンの有効期限（秒単位）。

解説

OAuthTokenTimestamp と併用して、アクセストークンの有効期限を決定します。

現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。

解説

OAuthExpiresIn と併用して、アクセストークンの有効期限を決定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

Java Web Token の発行者。

解説

Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note： このSync App は複数のスキーマをサポートするため、Workday カスタムスキーマファイルの構造は以下のようになります。

• 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
• これらのスキーマフォルダは親フォルダに含まれています。
• 親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Workday Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

The complete url to the API endpoint to use for making SOAP requests.

解説

Instead of entering the Tenant, Service, and Host individually, the complete API URL may be specified in the following format. For example:

https://<host>.workday.com/ccx/service/<tenant>/<Service>

For example, a complete API URL might appear as:

https://wd3-impl-services1.workday.com/ccx/service/mytenant/Human_Resources

Alternatively, the Service may be left out, which will enable all services enabled via the Service property. For example:

https://wd3-impl-services1.workday.com/ccx/service/mytenant

Determines whether the provider restricts queries to returning only 1 million rows.

解説

By default the Sync App will add a LIMIT 1000000 to any WQL query it executes. This prevents Workday from raising an error if the query would return too many values.

If you disable this option, the Sync App will not add the LIMIT clause. Any queries that would return more rows than the Workday row limit will instead raise an error.

Whether to expand multiple ID types when they appear in reports. Only has an effect for queries using the Reports as a Service (RaaS) API.

解説

Every Workday entity is identified by a WID (a GUID generated by Workday) but some types of entities have other types of identifiers. For example, a Workday country record for the United States would be identified using the "US" country code in addition to its WID.

By default the Sync App collects all these IDs under one column and produce an aggregate. This is the value of the Country_Reference.ID column for the US record:

<wd:Country_Reference>
    <wd:ID type="WID">abcdef1234567890</wd:ID>
    <wd:ID type="Country_Code">US</wd:ID>
</wd:Country_Reference>

If this option is enabled, the Sync App instead produces a separate column for each ID type. For the US record:

• The column Country_Reference.ID.WID is set to abcdef1234567890
• The column Country_Reference.ID.Country_Code is set to US

The maximum number of output rows that may be expanded from a single input row.

解説

When using ExpandMultiValues, the Sync App can generate multiple output rows for each input row from Workday. Each multi-value column included in the query increases the number of output rows exponentially. For example, if a table has five array columns and has one row has three values for each, then rows are generated in this pattern:

Realistic queries can output thousands of rows which can be expanded into hundreds of thousands of output rows. Generating these rows reduces the Sync App's performance and can potentially cause the Sync App to run out of memory.

To avoid this, the Sync App counts the number of output rows before actually generating them. If any input row would generate more rows than the ExpandMultiValueLimit, the Sync App reports an error instead. When this happens you should carefully evaluate the query and remove any array columns that are not required. Only increase this limit if there is no way to simplify your query.

Determines if multi-instance fields are expanded into separate rows.

解説

The behavior of this option depends upon the service you are connecting to. Please refer to the WQL section for an overview, as the reporting and SOAP sections only cover details specific to those services. Also refer to ExpandMultiValueLimit to understand the performance consequences of enabling this option.

WQL

WQL uses multi-value fields to reference multiple rows from another table, such one journal entry referencing multiple journal line items. By default the Sync App displays these as JSON aggregates which must be parsed to get individual values.

Enabling this option expands each of these multi-value references across multiple rows. The Sync App separates out each aggregate into an ID column and a descriptor column (the same as single-value ID fields). It also generates a new field called workdayIDIndex that counts the number of rows expanded from one WQL row. The workdayID and workdayIDIndex form a composite primary key, instead of the workdayID being the primary key on its own.

The Sync App only expands rows that are included in the SELECT clause of the query. If more than one multi-value reference is selected, its values are combined with the other multi-value fields using a CROSS JOIN. This ensures that all combinations are included in the output so they can be used in WHERE or JOIN conditions.

Reporting

The reporting API behaves similarly to the WQL API, with two main differences. The first is that two extra columns are added instead of just one. One is called RowIndex and it behaves the same as workdayIDIndex. The other is called RowNumber and it counts the number of original rows from the report. It is included because reports do not have a built-in primary key like WQL data sources do.

The second is that reporting supports the ExpandIDTypes option. By default single-value IDs are treated as multi-value fields and expanded in the same way. This is because even single-value references can have a separate value for each type of ID. If ExpandIDTypes is enabled then each type of ID gets its own column and only multi-value references are expanded across rows.

SOAP

The SOAP API exposes a more complex data model with different types of repeated values:

1. Mutli-value references that are similar to WQL and reporting multi-value references.
2. Basic multi-value fields like Address_Line_Data in the Workers_Address_Data table.
3. Complex multi-value structures that contain multiple fields.

This property only applies to the first two types because complex repeated structures are always exposed as child tables. The other two types behave similarly to WQL and reporting APIs with a few exceptions:

• Multi-value references have only an ID. No descriptor is included.
• If the table normally has a primary key, the Sync App adds only an IDIndex column that behaves like workdayIDIndex. Otherwise the Sync App adds a row counter called RowID in addition to the IDIndex column.

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Specifies what types of fields are ignored by the provider.

解説

Several types of fields in Workday are slow to read or are common sources of query errors. Excluding these fields at the Sync App level allows for faster and more reliable queries without explicitly excluding these columns for every query. If a field is included in this property, it does not show up in table metadata and it cannot be used in queries.

This property can be set to a comma-separated list containing any combination of the following field types. For example, Calculated,MultiInstance will exclude both calculated and multi-instance fields.

• Calculated Calculated fields require additional processing in Workday that can slows down queries. These fields typically start with a "cf_" prefix.
• MultiInstance Multi-instance fields are lists of IDs which refer to other Workday records. These lists can be large, which leads to slower queries because Workday must collect and format the entire list before returning it.
• Undefined Undefined fields are listed as being part of a WQL data source, but don't have a separate field definition. This can lead to errors when querying them because Workday cannot find their metadata.

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

Workday から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Workday から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM [CData].[Human_Resources].Workers WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

The URL to the WSDL. Only avaialble for the SOAP API.

解説

As an alternative to entering Service and WSDLVersion, the WSDL URL may be entered directly. For example:

https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v34.1/Human_Resources.wsdl

The version of the WSDL to use. Only available for the SOAP API.

解説

The WSDL Version for Workday changes often. If you would like to use the latest version, the version may be set to a higher value here to match the latest release. Alternatively, set the WSDLURL directly and this property will be ignored.