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 Establishing a Connection.
| 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, formatted as 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 | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| 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. |
| 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. |
| ClientID | The Client ID of the distributed child company to access. |
| 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. |
| EnableSubscriptions | Provide the comma separated list of subscriptions enabled for the Sage Intacct account to allow access for specific tables related to the subscriptions. |
| IncludeDetailAggregate | A boolean indicating if aggregate columns should be displayed. |
| IncludeGLEntries | Sage Intacct allows users to update the GLBatch table with new GLEntry items.By default the driver will include existing GLEntry items assocaited with the record being updated. When this option is set to false the driver will not include the existing items and they will be deleted from the table. |
| IncludeRelatedAttributes | The extend of related attributes to be queried. |
| LocationsId | The Location ID of the shared child company to access. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| 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. |
| 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. |
| 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. |