Tableau Connector for Sage Intacct

Build 21.0.7930

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.

Authentication


PropertyDescription
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
CompanyIDThe Company ID of the user who is authenticating to Intacct.
URLThe endpoint URL used to connect to Intacct. The default value of this property is usually sufficient.
UserThe Sage Intacct user account used to authenticate.
PasswordThe password used to authenticate the user.
SenderIDThe Web Services SenderID assigned to you by Intacct.
SenderPasswordYour registered Web Services password.

Miscellaneous


PropertyDescription
UseLegacySet to False to use new API implementation.
BatchSizeThe maximum size of each batch operation to submit.
ClientIDThe Client ID of the distributed child company to access.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property species whether to connect to the Sage Intacct when the connection is opened.
DocParIdUsed to select different groups of columns exposed on Intacct. The docparid should be an object type from the Objects list, available under Platform Services.
GetdeletedTablesProvide the comma separated list of the tables and the corresponding key columns to support the GETEDELETED statement.
IncludeDetailAggregateA boolean indicating if aggregate columns should be displayed.
IncludeRelatedAttributesA boolean indicating if attributes of related objects should be displayed.
LocationsIdThe Location ID of the shared child company to access.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MinimumColumnSizeIf field size information from the Intacct API appears to be incorrect or does not match what you expect, set this value to change the field sizes received by the driver, and make them greater than or equal to this value. This connection property does not apply if Intacct returns no valid field size information at all, and only applies to columns with string data type.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Sage Intacct.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to Sage Intacct from the provider.
ReturnFormatAsXMLA boolean indicating if Intacct's XML return format should be used, rather than the JSON return format. By default, the XML return format is used.
RTKThe runtime key used for licensing.
SupportEnhancedSQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPoolingThis property enables connection pooling.

Connection


PropertyDescription
SessionIDThe session ID used to connect to Intacct.
UseSessionIDSet to true if connecting with a SessionID.

SSO


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.

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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver to be used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930