Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
You can connect to either Act! CRM or Act! Premium Cloud. Set the following to connect:
User: The username used to authenticate to the Act! database.
Password: The password used to authenticate to the Act! database.
URL: The URL where the Act! CRM account is hosted. For example: http://serverName/.
ActDatabase: The name of the Act! database you want to connect to. This is found by going to the About Act! Premium menu of your account, found at the top right of the page, in the ? menu. Use the Database Name in the window that appears.
ActCloudName (Act! Premium Cloud only): The handle assigned to the Act! Premium Cloud account. It is found in the browser's address field when opening the online account, in the form https://eup1-iis-04.eu.hosted.act.com/ActCloudName.
Begin by providing your Bullhorn CRM account credentials in the following:
DataCenterCode: Set this to the data center code which responds to your data center. Refer to the list here.
If you are uncertain about your data center code, codes like CLS2, CLS21, etc. are cluster IDs that are contained in a user's browser URL (address bar) once they are logged in.
Example: https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... indicates that the logged in user is on CLS21.
Bullhorn CRM uses the OAuth 2.0 authentication standard.
To authenticate using OAuth, you will need to create and configure a custom OAuth app.
OAuth requires the authenticating user to interact with Bullhorn CRM using the browser. The provider facilitates this in various ways as described below. Important note: At the moment there is a bug in the Bullhorn CRM API. See this link. This error occurs when you already are logged in the browser you're using for authentication. You should use another browser to avoid the error.
In order to connect using Custom Credentials, you will need to register an app to obtain the OAuthClientId and OAuthClientSecret. For this, you must contact the Bullhorn team, to provide you with the credentials (ClientId and ClientSecret). OAuth is something only available to Bullhorn partners. You can find additional details here.
In addition, the CallbackUrl or Redirect Uri will default to a page on bullhorn.com.
In order to utilize setting InitiateOAuth to GETANDREFRESH, Bullhorn staff must be contacted and a separate CallbackUrl must be requested.
Microsoft Dynamics 365 Sales uses oAuth Authentication
Other properties (Proxy...) are detailed in section common properties
For CRM on-premises, select an authentication method. By default, the connector uses Windows (NTLM) authentication: set Url to the root URL of your organization and set User, Password, and CRMVersion On-Premise.
To use another authentication type, such as Kerberos delegation, set AuthScheme.
For Dynamics CRM with IFD, set InternetFacingDeployment to true.
See Dynamics365 - Connection Settings
To authenticate to Dynamics CRM using Kerberos, set the following properties:
AuthScheme: Set this to KERBEROS
KerberosKDC: Set this to the host name or IP Address of your Kerberos KDC machine.
KerberosSPN: Set this to the service and host of the Dynamics CRM Kerberos Principal. This will be the value prior to the '@' symbol (for instance, ) of the (for instance, ).
You can use one of the following options to retrieve the required Kerberos ticket.
This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. Note that you won't need to set the User or Password connection properties with this option.
Ensure that you have an environment variable created called KRB5CCNAME.
Set the KRB5CCNAME environment variable to a path pointing to your credential cache file (for instance, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0). This file will be created when generating your ticket with MIT Kerberos Ticket Manager.
To obtain a ticket, open the MIT Kerberos Ticket Manager application, click Get Ticket, enter your principal name and password, then click OK. If successful, ticket information will appear in Kerberos Ticket Manager and will now be stored in the credential cache file.
Now that the credential cache file has been created, the provider will use the cache file to obtain the kerberos ticket to connect to Dynamics CRM.
As an alternative to setting the KRB5CCNAME environment variable, you can directly set the file path using the KerberosTicketCache property. When set, the connector will use the specified cache file to obtain the kerberos ticket to connect to Dynamics CRM.
If the KRB5CCNAME environment variable has not been set, you can retrieve a Kerberos ticket using a Keytab File. To do this, set the User property to the desired username and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.
If both the KRB5CCNAME environment variable and the KerberosKeytabFile property have not been set, you can retrieve a ticket using a User and Password combination. To do this, set the User and Password properties to the user/password combo that you use to authenticate with Dynamics CRM.
More complex Kerberos environments may require cross-realm authentication where multiple realms and KDC servers are used (e.g. where one realm/KDC is used for user authentication and another realm/KDC used for obtaining the service ticket).
In such an environment, the KerberosRealm and KerberosKDC properties can be set to the values required for user authentication. The KerberosServiceRealm and KerberosServiceKDC properties can be set to the values required to obtain the service ticket.
The following are the connection properties for DynamicsCRM. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Oracle Sales uses Basic authentication over SSL; after setting the following connection properties, you are ready to connect:
Username: Set this to the user name that you use to log into your Oracle Cloud service.
Password: Set this to your password.
HostURL: Set this to the Web address (URL) of your Oracle Cloud service.
You can connect to SuiteCRM data via the V4.1 API by simply setting the following connection properties:
Schema: Set this to suitecrmv4.
Url: Set this to the URL associated with the SuiteCRM application, for example http://suite.crm.com.
User: Set this to the user associated with the SuiteCRM account.
Password: Set this to the password associated with the SuiteCRM account.
Before you connect to SuiteCRM V8 API you will need to first configure it in your SuiteCRM instance. The API can be configured in SuiteCRM version 7.10+. To configure the API, please follow the steps written in the SuiteCRM JSON API docs, found here: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_before_you_start_calling_endpoints .
The SuiteCRM V8 API uses OAuth2.0 as its main method of authentication using 2 types of grant type, password or client credentials.
The SuiteCRM V8 API uses OAuth2.0 as its main method of authentication using 2 types of grant type, password or client credentials. To authenticate to SuiteCRM V8 API, please do the following. Note that you have to be an admin to create credentials, create roles, assign roles to users etc.
Note: The OAuth flow is the same in a headless machine.
To obtain the OAuth client credentials, the consumer key, and consumer secret:
Log in to your admin account.
On profile dropdown select Admin > OAuth2 Clients and Tokens and click New Password Client or New Client Credentials Client.
Enter a name and a secret.
Click Save.
Usually when authenticating with a client credentials grant type, you will have full access to the API. For authentication with password grant type, the user should have permissions for each module/table.
Users' access to certain resources can be set by configuring REST roles and assigning users to the specific REST roles.
To create a role:
On the profile dropdown, select Admin > Role Management and click Create Role.
Enter name and description and click Save. Then, you will be redirected to the role configuration menu where you can select permissions to any operation on any module.
After you are done with setting up the permissions, you can click Save.
To assign a role to a user:
On profile dropdown, select Admin > Role Management and click on the role you want to assign to a user.
Scroll down to the bottom and click Select User.
A user search window will appear.
Select the users you want to assign the role to and click Select > Save.
After setting the following connection properties, you are ready to connect:
Schema: Set this to the suitecrmv8.
AuthScheme: Set this to OAuthClient.
OAuthClientId: Set this to the client key that you received.
OAuthClientSecret: Set this to the client secret that you noted.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.
After setting the following connection properties, you are ready to connect:
Schema: Set this to the suitecrmv8.
AuthScheme: Set this to OAuthPassword.
OAuthClientId: Set this to the client key that you received.
OAuthClientSecret: Set this to the client secret that you noted.
User: Set this to the username associated with the user.
Password: Set this to the password associated with the user.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.
SAP Hybris Cloud for Customer uses basic authentication. Set the Url and Tenant to the appropriate values for your instance and set User and Password to your login credentials.
Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.
By default, the connector uses the production environments. Set UseSandbox to true to use a Salesforce sandbox account. If you are using user/password authentication, ensure that you specify a sandbox user name in User.
There are several authentication methods available for connecting to Salesforce including login credentials, SSO, and OAuth.
Set the AuthScheme to Basic and set the User and Password to your login credentials. Additionally, set the SecurityToken. By default, the SecurityToken is required, but you can make it optional by allowing a range of trusted IP addresses.
To disable the security token:
Log in to Salesforce and enter Network Access in the Quick Find box in the setup section.
Add your IP address to the list of trusted IP addresses.
To obtain the security token:
Open the personal information page on Salesforce.com.
Click the link to reset your security token. The token will be emailed to you.
Specify the security token in the SecurityToken connection property or append it to the Password.
Set the AuthScheme to OAuth. If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow.
To obtain the OAuth client credentials, consumer key, and consumer secret:
Log in to Salesforce.com.
From Setup, enter Apps in the Quick Find box and then click the link to create an app. In the Connected Apps section of the resulting page, click New.
Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact Email address.
Click Enable OAuth Settings and enter a value in the Callback URL box. Set the Callback URL to the appRules URL (must be https).
Select the scope of permissions that your app should request from the user.
Click your app name to open a page with information about your app. The OAuth client credentials, the consumer key, and consumer secret are displayed.
After setting the following connection properties, you are ready to connect:
OAuthClientId: Set to the consumer key in your app settings.
OAuthClientSecret: Set to the consumer secret in your app settings.
CallbackURL: Set to the callback URL in your app settings.
InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
When you connect, the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.
Set the AuthScheme to OAuthJWT.
To obtain the OAuthJWT consumer key:
Log in to Salesforce.com.
From Setup, enter Apps in the Quick Find box and then click the link to create an app. In the Connected Apps section of the resulting page, click New.
Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact Email address.
Click Enable OAuth Settings and enter a value in the Callback URL box. Set this value only to create the Connected App as it is required. It will not actually be needed for this type of authentication. The Callback URL is in the format:
Enable Use digital signatures.
Upload your certificate.
Select the scope of permissions that your app should request from the user.
Click your app name to open a page with information about your app. The OAuth consumer key is displayed.
After creating your OAuth Application, set the following connection properties:
AuthScheme: Set to OAuthJWT.
InitiateOAuth: Set to GETANDREFRESH.
OAuthJWTCert: Set this to the JWT Certificate store.
OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
OAuthJWTCertPassword: Set this to the Password of the JWT Certificate store.
OAuthJWTIssuer: Set this to the OAuth Client ID.
OAuthJWTSubject: Set this to the username (email address) to the permitted User Profile configured in the OAuth Connected App.
Note: This flow never issues a refresh token.
Set the AuthScheme to AzureAD. The following connection properties are used to connect to AzureAD:
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
Note that this configuration requires two AAD applications: the "Salesforce" application used for single sign-on, and a separate "connector" application with user_impersonation permission on the "Salesforce" application. You must also specify the OAuth connection properties:
OAuthClientId: The application ID of the connector application, listed in the Overview section of the app registration.
OAuthClientSecret: The client secret value of the connector application. Azure AD displays this when you create a new client secret.
The following SSOProperties are used to authenticate to AzureAD:
Resource: The application ID URI of the Salesforce application, listed in the Overview section of the app registration. In most cases this is the URL of your custom Salesforce domain.
AzureTenant: The ID of the Azure AD tenant where the applications are registered.
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
User: Set this to the Okta user.
Password: Set this to Okta password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
The following SSOProperties are needed to authenticate to Okta:
APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides OKTA client request context.
Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:
User: Set this to the OneLogin user.
Password: Set this to OneLogin password for the user.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
The following SSOProperties are needed to authenticate to OneLogin:
OAuthClientId: Set to the OAuthClientId, which can be obtained by selecting Developers > API Credentials > Credential > ClientId.
OAuthClientSecret: Set to the OAuthClientSecret, which can be obtained by selecting Developers > API Credentials > Credential > ClientSecret.
Subdomain: Set to the subdomain of the OneLogin user accessing the SSO app. For example, if your OneLogin URL is splinkly.onelogin.com, enter splinkly as the subdomain value.
AppId: Set to the ID of the SSO app.
Region (optional): Set to the region your OneLogin account resides in. The OneLogin API operates in multiple regions and this property is used to find the correct domain. It can take one of the following values:
US (default)
EU
Set the AuthScheme to PingFederate. The following connection properties need to be set:
User: Set this to the PingFederate user.
Password: Set this to PingFederate password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
The following SSOProperties are needed to authenticate to PingFederate:
AuthScheme (optional): The authorization scheme to be used for the IdP endpoint. The allowed values for this IdP are None or Basic.
Additionally, you can use the following SSOProperties to configure mutual SSL authentication for SSOLoginUrl, the WS-Trust STS endpoint:
SSLClientCert
SSLClientCertType
SSLClientCertSubject
SSLClientCertPassword
Set the AuthScheme to ADFS. The following connection properties need to be set:
User: Set this to the ADFS user.
Password: Set this to ADFS password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.
The following SSOProperties are needed to authenticate to ADFS:
RelyingParty: This attribute is the value of the Relying Party Identifier on the ADFS server for Salesforce.
The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, simply do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.
The following are the connection properties for Salesforce. Not all properties are required. Enter only property values pertaining to your Salesforce instance. Several properties will be automatically initialized with the appRules defaults.
If a connection property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.
Specify the following to establish a connection to SugarCRM:
URL: Set this to the URL associated with the SugarCRM account in the form 'http://{sugar crm instance}.com'.
Platform: If you're encountering a login conflict during authentication, set this to one of the platforms that you have created in the SugarCRM UI.
SugarCRM uses the OAuth 2.0 authentication standard. It uses the "password" grant type to retrieve the access token, therefore it does NOT open a browser tab during the authentication process.
You can authenticate with your SugarCRM account using your user-credentials.
After setting the following properties, you are ready to connect:
User: Set this to the username of the SugarCRM account you're trying to access.
Password: Set this to the password of the SugarCRM account you're trying to access.
Url: Set this to the URL of the SugarCRM instance you're trying to access.
In addition to the above 3 properties you can (optionally) specify your own OAuth Consumer Keys to be used during the authentication process. This is done using properties OAuthClientId and OAuthClientSecret. To create a new set of OAuth Consumer Keys you must first be logged in as an admin. After that, follow the below steps:
Open SugarCRM on your browser and navigate to the Admin Dashboard.
On the top-right of the site click on your profile and then click on "Admin".
In the "System" section select "OAuth Keys". Now all your default Consumer Keys will appear.
On the main navigation bar (on top of the site) find "OAuth Keys" and click the arrow to open the dropdown list.
Click on "Create OAuth Key".
Fill the required fields. Set "OAuth Version" to "OAuth 2.0". The values you'll be filling for "Consumer Key" and "Consumer Secret" are your OAuthClientId and OAuthClientSecret, respectively.
Hit "Save" and your new OAuth Consumer Key will be created.
You do not need to reauthenticate when you open a new connection: The provider saves the temporary tokens resulting from the OAuth exchange into OAuthSettingsLocation to be persisted across connections.
The following are the connection properties for SugarCRM. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Veeva CRM uses the same interface for data connectivity as Salesforce & Force.com. To connect to Veeva CRM data, go to section
http://localhost:8019/src/oauthCallback.rst
Property
Description
Authentication
AuthScheme
The type of authentication to use when connecting to Salesforce.
Password
The password used to authenticate the user.
SecurityToken
The security token used to authenticate access to the Salesforce account.
User
The Salesforce user account used to authenticate.
UseSandbox
A boolean determining if the connection should be made to a Salesforce sandbox account.
BulkAPI
BulkAPIConcurrencyMode
The concurrency mode for processing bulk rows with BULK API v1.
BulkPageSize
The number of records to retrieve before returning results to the user when UseBulkAPI=true.
BulkPollingInterval
The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms.
BulkQueryTimeout
The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
UseBulkAPI
Whether to use the synchronous SOAP API or the asynchronous Bulk API.
WaitForBulkResults
Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.
Caching
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Connection
APIVersion
The version of the Salesforce API used.
LoginURL
URL to the Salesforce server used for logging in.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
JWT OAuth
OAuthJWTCert
The JWT Certificate store.
OAuthJWTCertPassword
The password for the OAuth JWT certificate.
OAuthJWTCertSubject
The subject of the OAuth JWT certificate.
OAuthJWTCertType
The type of key store containing the JWT Certificate.
OAuthJWTIssuer
The issuer of the Java Web Token.
OAuthJWTSubject
The user subject for which the application is requesting delegated access.
Logging
Logfile
A filepath which designates the name and location of the log file.
LogModules
Core modules to be included in the log file.
MaxLogFileCount
A string specifying the maximum file count of log files.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
AllOrNone
A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails.
ArchiveMode
Boolean indicating whether to include deleted and archived records with a standard SELECT query.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
ContinueOnAlterException
Whether you want to continue after a ALTER statement has failed.
FilterScope
Optional scope to limit the records returned from queries.
IncludeMetadataDescription
Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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
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 Salesforce from the provider.
ServerSideAggregation
A boolean determining if server side aggregation should be used.
SessionTimeout
The time in minutes for which a Salesforce login session is reused.
SkipFormulaFields
Set to true if formula fields should be skipped when listing columns.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling
This property enables connection pooling.
UseDisplayNames
Boolean determining if the display names for the columns should be used instead of the API names.
OAuth
CallbackURL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken
The access token for connecting using OAuth.
OAuthAccessTokenURL
The URL to retrieve the OAuth access token from.
OAuthAuthorizationURL
The authorization URL for the OAuth service.
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.
OAuthExpiresIn
The lifetime in seconds of the OAuth AccessToken.
OAuthRefreshToken
The OAuth refresh token for the corresponding OAuth access token.
OAuthServerURL
The server URL to use if authenticating with OAuth.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthTokenTimestamp
The Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
Schema
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
SSL
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SSO
SSOExchangeUrl
The url used for consuming the SAML response and exchanging it with Salesforce specific credentials.
SSOLoginURL
The identity provider's login URL.
SSOProperties
Additional properties required to connect to the identity provider in a semicolon-separated list.
Property
|
Description
|
Authentication |
APIVersion | The version of the SugarCRM API used. |
Password | The password of the Sugar CRM account. |
URL | The URL of the SugarCRM account. |
User | The user of the Sugar CRM account. |
Firewall |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
Logging |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Misc |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectionString | *** |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Platform | The SugarCRM platform that you want to use during your session. |
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 | 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. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseConnectionPooling | This property enables connection pooling. |
OAuth |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthClientId | The consumer key obtained from the OAuth token settings. |
OAuthClientSecret | The consumer secret obtained during application registration. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
Proxy |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
The provider is already registered with Zoho CRM as an OAuth application. As such,
You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect: InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process.
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
If you prefer to use your own custom OAuth app:
Before you get started with authorization and make any calls to the Zoho CRM API, you need to register your application with Zoho CRM. You can follow the procedure below to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
Go to accounts.zoho.com/developerconsole
Click Add Client, then Server-Based Application
Enter the client name, homepage URL, and redirect URL.
4. If you are connecting from a desktop application, set the callback URL to http://localhost:33333, or another port number of your choice.
If you are connecting from a Web application, set the callback URL you want to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access.
Click Create.
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
OAuthClientId: Set this to the client Id you defined for your OAuth app.
OAuthClientSecret: Set this to the client secret you defined for your OAuth app.
CallbackURL: Set this to the callback URL you defined for your OAuth app.
When you connect, the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
The Zoho CRM provider defaults UseServerSideFiltering to True for higher performance, though it may return incorrect results.
The following are the connection properties for ZohoCRM. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Property
Description
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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
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 Zoho CRM from the provider.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling
This property enables connection pooling.
Miscellaneous
Domain
Determines the domain where authentication calls will be sent to.
IncludeCustomViews
If set to true, the provider will display custom views among the other views and make them available for use.
UseDisplayNames
If set to false, the provider will use api names for some operations.
UseSandbox
Determines whether the calls will be sent to a Sandbox instance instead of a regular one.
UseServerSideFiltering
If set to false, the provider will not send the filters server-side but will process them client-side.
UseSimpleNames
Boolean determining if simple names should be used for tables and columns.
OAuth
CallbackURL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken
The access token for connecting using OAuth.
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.
OAuthRefreshToken
The OAuth refresh token for the corresponding OAuth access token.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.