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 method the provider uses to authenticate to Sage Intacct. Select an option from the available values. |
| CompanyID | The Company ID of the company associated with your user account. To find this ID, click the dropdown menu next to the home button (house icon) and navigate to Company > Configuration > Company. The value is visible on this page under Company information > Company ID. |
| URL | The endpoint URL used by the provider to make API requests to Sage Intacct. If your endpoint URL differs from the default value, supply it here. |
| User | The username of the authenticating Sage Intacct user account. |
| Password | The password associated with the authenticating Sage Intacct user (set in the User property). |
| SenderID | The sender ID that was assigned to you by Sage Intacct alongside your Web Services developer license. |
| SenderPassword | The sender password that was assigned to you by Sage Intacct alongside your Web Services developer license. |
| Property | Description |
| SessionID | The session ID of your current Sage Intacct login session. When the UseSessionId property is set to True, this session ID is used to authenticate the provider against Sage Intacct. To obtain a session ID, examine the URL of the webpage you are brought to upon logging in to Sage Intacct. Your session ID is the value found in the URL after 'sess=' and before '&.uid'. |
| UseSessionID | When set to True, the provider uses a session ID (set in the SessionID connection property) to authenticate the provider against Sage Intacct. |
| 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 |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Sage Intacct data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| UseLegacy | When set to True, the provider uses the old API implementation. When set to False, the provider uses the new API implementation. The new API supports server-side filtering, ORDER BY clauses, as well as offset and aggregate functions including COUNT, AVG, MIN, MAX and SUM. |
| ClientID | A company ID of a child company that you want to connect to. When a value is set for this property, data returned by the provider is limited to the data organized under this company. |
| DocParId | The name of a transaction type, exactly as it appears in the Applications dropdown under (your desired application) > 'All' tab > 'Transactions'. The provider returns custom fields associated with the specified transaction type. For example: 'Sales Invoice'. |
| EnableSubscriptions | A list of one or more subscriptions enabled in your Sage Intacct account. The provider exposes any tables exclusive to the specified subscription(s). If multiple subscriptions are specified, separate them with commas. For example: 'Subscription1,Subscription2'. |
| IncludeDetailAggregate | If True, aggregate columns are displayed in query results. |
| IncludeGLEntries | If True, when updating the GLBatch table with new GLEntry items, the provider includes existing GLEntry items associated with the record being updated. If False, the provider does not include the existing items, and they are deleted from the table. |
| IncludeItemDetails | If True, aggregate columns are displayed in query results for the 'INVDOCUMENTPARAMS', 'PODOCUMENTPARAMS', and 'SODOCUMENTPARAMS' tables. |
| IncludeRelatedAttributes | The scope of related attributes retrieved by the provider. Use this only when the 'UseLegacy' connection property is set to False. |
| LocationsId | The Location ID of the shared child company that you want to access. When this property is set, data returned by the provider is limited to the data organized under this Location. To find Location Ids, click the dropdown menu next to the Home button (house icon), then navigate to Reports > Dimensions > Locations (click the text, not the +). |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MinimumColumnSize | The minimum column size returned by the provider. All column sizes reported by the provider are equal or greater to this value. When set to the default value (-1), the provider reports the exact column sizes it receives from Sage Intacct. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | The maximum number of records per page the provider returns when requesting data from Sage Intacct. |
| PreferredDateFormats | A semicolon separated string containing a list of DateTime formats which should be tried when parsing DateTime values. |
| ReadByName | If True, the provider uses the ReadByName clause in its XML request to the Sage Intacct API. This allows the provider to query API endpoints that require this clause. Use this only when the UseLegacy connection property is set to True. It is rare for tables or views to require setting this property. |
| Readonly | Toggles read-only access to Sage Intacct from the provider. |
| ReturnFormatAsXML | If set to True, the Sage Intacct API returns requested data in XML format. If False, the Sage Intacct API returns data in JSON format. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| ShowPrivateEntityData | When using newer elements of the Sage Intacct API by setting UseLegacy to False , setting this property to True will cause queries to return data from private entities owned by the top-level entity targeted by the query. Setting this to false will cause queries to only return data from the top-level entity. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |