TDV Adapter for Workday

Build 23.0.8839

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Basic Tab.

Authentication


PropertyDescription
ConnectionTypeThe method to use to connect to Workday.
AuthSchemeThe type of authentication to use when connecting to Workday.
TenantThe tenant for the account.
BaseURLThe base URL for the Workday connection.
UserThe Workday user account used to authenticate.
PasswordThe password used to authenticate the user.
ServiceThe specific SOAP service or services to retrieve data from. Enter as a comma seperated list.
UseSplitTablesWhether to split WQL data sources into multiple tables.
CustomReportURLThe URL Of the report that shows all Reports as a Service (RaaS) reports.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.

JWT OAuth


PropertyDescription
OAuthJWTCertThe JWT Certificate store.
OAuthJWTCertTypeThe type of key store containing the JWT Certificate.
OAuthJWTCertPasswordThe password for the OAuth JWT certificate.
OAuthJWTCertSubjectThe subject of the OAuth JWT certificate.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.

Miscellaneous


PropertyDescription
APIURLThe complete url to the API endpoint to use for making SOAP requests.
EnforceWQLRowLimitDetermines whether the provider restricts queries to returning only 1 million rows.
ExpandIDTypesWhether to expand multiple ID types when they appear in reports. Only has an effect for queries using the Reports as a Service (RaaS) API.
ExpandMultiValueLimitThe maximum number of output rows that can be expanded from a single input row.
ExpandMultiValuesDetermines if multi-instance fields are expanded into separate rows.
IncludeChildTableAggregatesFor the SOAP API, whether or not to include aggregate columns for child tables.
IncludeIDInDescriptorDetermines whether the provider includes the ID in descriptor fields. This only applies when ConnectionType is WQL.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MetadataFiltersSpecifies what types of fields are ignored by the provider.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Workday.
SingleEntryTablesTreats the specified SOAP tables as having one entry per row, even if Workday says they are collections.
SplitSingleValuePromptsWhether the provider should split lists of prompt values when Workday only allows one.
TablePageSizesAllows overriding the default page size when ConnectionType is SOAP.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
WQLDataSourceFiltersDetermines what data source filters the provider uses when querying WQL data sources.
WSDLURLThe URL to the WSDL. Only avaialble for the SOAP API.
WSDLVersionThe version of the WSDL to use. Only available for the SOAP API.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839