Parameters (Connect-SugarCRM Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
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 | This indicates whether to use the system proxy settings or not. |
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 . |
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 |
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. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |