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 |
| User | The SugarCRM user account used to authenticate. |
| Password | The password used to authenticate the user. |
| APIVersion | The version of the SugarCRM used. |
| URL | The URL of the SugarCRM account in the form 'http://{sugar crm instance}.com'. |
| Platform | The SugarCRM platform that you want to use during your session. |
| 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://'. |
| 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 |
| 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 |
| 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 |
| Pagesize | The maximum number of results to return per page from SugarCRM. |
| AggregateColumnMode | Controls how aggregate columns are treated by the provider. |
| LinkColumnsMode | Controls how the 'link' type columns are exposed by the provider provider. |
| UseDisplayNames | Set this to true to use the table and column names from the UI. By default, the provider displays the API names for tables and columns. |
| DisplayLanguage | The language used with the provider. This affects table names, view names and column names. |
| IncludeRelationships | Set this to true if you want to expose relationship columns, which give you the ability to query objects in relation to other objects. |
| IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views. |
| ModulesFiltersList | Each SugarCRM module has named filters. This property enables you to control the list of filters that the provider exposes (as a view) for each module. |
| IncludeReports | Set this to true if you want to expose reports as views. |
| ReportModulesList | In SugarCRM, each report is built upon a specific module. This connection property enables you to control the list of reports the provider exposes as Views. |
| FlattenReportObjects | Specifies whether or not to flatten the objects' data for report views. |
| FlattenReportsArrayDepth | Specifies the maximum depth of array elements to flatten for report views. |
| IncludeDeleted | Specify whether to get deleted records. |
| ServerSideOrderBy | Set this to true if you want to perform the order by operation server-side. Keep in mind that having or creating indexes results in the best query performance. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Readonly | You can use this property to enforce read-only access to SugarCRM from the provider. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| 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. |