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.
Property | Description |
ConnectionType | The method to use to connect to Workday. |
AuthScheme | The type of authentication to use when connecting to Workday. |
Tenant | The tenant for the account. |
BaseURL | The base URL for the Workday connection. |
User | The Workday user account used to authenticate. |
Password | The password used to authenticate the user. |
Service | The specific SOAP service or services to retrieve data from. Enter as a comma seperated list. |
UseSplitTables | Whether to split WQL data sources into multiple tables. |
CustomReportURL | The URL Of the report that shows all Reports as a Service (RaaS) reports. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
Property | Description |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The 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://'. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Property | Description |
APIURL | The complete url to the API endpoint to use for making SOAP requests. |
EnforceWQLRowLimit | Determines whether the provider restricts queries to returning only 1 million rows. |
ExpandIDTypes | 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. |
ExpandMultiValueLimit | The maximum number of output rows that can be expanded from a single input row. |
ExpandMultiValues | Determines if multi-instance fields are expanded into separate rows. |
IncludeChildTableAggregates | For the SOAP API, whether or not to include aggregate columns for child tables. |
IncludeIDInDescriptor | Determines whether the provider includes the ID in descriptor fields. This only applies when ConnectionType is WQL. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MetadataFilters | Specifies what types of fields are ignored by the provider. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Workday. |
SingleEntryTables | Treats the specified SOAP tables as having one entry per row, even if Workday says they are collections. |
SplitSingleValuePrompts | Whether the provider should split lists of prompt values when Workday only allows one. |
TablePageSizes | Allows overriding the default page size when ConnectionType is SOAP. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
WQLDataSourceFilters | Determines what data source filters the provider uses when querying WQL data sources. |
WSDLURL | The URL to the WSDL. Only avaialble for the SOAP API. |
WSDLVersion | The version of the WSDL to use. Only available for the SOAP API. |