Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
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. |
BatchSize | The maximum size of each batch operation to submit. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectOnOpen | This property specifies whether to connect to the SugarCRM when the connection is opened. |
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. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
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. |
RTK | The runtime key used for licensing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseConnectionPooling | This property enables connection pooling. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |