Connection Properties
The connection 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 settings for this provider. Click the links for further details.
For more information on establishing a connection, see Getting Started.
Property | Description |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
CompanyID | The Company ID of the user who is authenticating to Intacct. |
URL | The endpoint URL used to connect to Sage Intacct. The default value of this property is usually sufficient. |
User | The Sage Intacct user account used to authenticate. |
Password | The password used to authenticate the user. |
SenderID | The Web Services SenderID assigned to you by Intacct. |
SenderPassword | Your registered Web Services password. |
Property | Description |
SessionID | The session ID used to connect to Intacct. |
UseSessionID | Set to true if connecting with a SessionID. |
Property | Description |
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
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 |
Logfile | A filepath which designates the name and location of the log file. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
LogModules | Core modules to be included in the log file. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
MaxLogFileCount | A string specifying the maximum file count of log files. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheProvider | The name of the provider to be used to cache data. |
CacheDriver | The database driver used to cache data. |
CacheConnection | The 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. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Offline | Use offline mode to get the data from the cache instead of the live source. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Property | Description |
UseLegacy | Set to False to use new API implementation. |
BatchSize | The maximum size of each batch operation to submit. |
ClientID | The Client ID of the distributed child company to access. |
DefaultDomain | This property is used for the Oracle Database Gateway for ODBC. |
DocParId | Used to select different groups of columns exposed on Sage Intacct. The docparid should be an object type from the Objects list, available under Platform Services. |
EnableForeignKeyDetection | Whether to detect the foreign keys in ODBC. |
IncludeDetailAggregate | A boolean indicating if aggregate columns should be displayed. |
IncludeDualTable | Set this property to mock the Oracle DUAL table for better compatibility with Oracle database. |
IncludeRelatedAttributes | The extend of related attributes to be queried. |
LimitKeySize | The maximum length of a primary key column. |
LocationsId | The Location ID of the shared child company to access. |
MapBigintToVarchar | This property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default. |
MapToInt | This property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default. |
MapToLongVarchar | This property controls whether or not a column is returned as SQL_LONGVARCHAR. |
MapToWVarchar | This property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default. |
MaximumColumnSize | The maximum column size. |
MaxRows | Limits 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. |
MinimumColumnSize | If 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. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Sage Intacct. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
ReadByName | A boolean indicating if Intacct's XML request should use ReadByName clause. |
Readonly | You can use this property to enforce read-only access to Sage Intacct from the provider. |
ReturnFormatAsXML | A 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. |
RTK | The runtime key used for licensing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UpperCaseIdentifiers | This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |