skip to main content
Parameters for all supported Data Store types : SugarCRM connection parameters : SugarCRM connection parameters (on-premise)
 

Try DataDirect Cloud Now

SugarCRM connection parameters (on-premise)

You define the information that DataDirect Cloud needs to connect to the data store in a data source. These default connection values are used each time you or your application connects to a particular data store. In addition to user credentials, the data store may provide other options you can use to tune performance.
The following tables describes parameter available on the SugarCRM Data Source setup dialog.
*General tab
*Security tab
*Mapping tab
*OData tab
*Advanced tab

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the SugarCRM data source setup dialog (on-premise)General tab of the SugarCRM data source setup dialog (on-premise)
Table 158. General tab connection parameters for SugarCRM
Field
Description
Connector ID
The unique identifier of the DataDirect Cloud On-Premise Connector that is to be used to access the on-premise data source. Click the arrow Down arrow for a field) and select the Connector that you want to use. The identifier can be a descriptive name, the name of the machine where the Connector is installed, or the Connector ID for the Connector.
If you have not installed an On-Premises Connector, and no Connectors have been shared with you, this field and drop-down list are empty.
If you own multiple Connectors that have the same name, for example, Production, an identifier is appended to each Connector, for example, Production_dup0 and Production_dup1. If the Connectors in the drop-down list were shared with you, the owner's name is appended, for example, Production(owner1) and Production(owner2).
Data Source Name
A unique name for this Data Source definition.
Note: Names can contain only alphanumeric characters and underscores.
Description
A description of this set of connection parameters.
User Id, Password
The login credentials for your SugarCRM cloud data store account.
DataDirect Cloud uses this information to connect to the data store. The administrator of the cloud data store must grant permission to a user with these credentials to access the data store and the target data.
Note: By default, the password is encrypted.
Note: You can save the Data Source definition without specifying the login credentials. In that case, when you test the Data source connection, you will be prompted to specify these details. Applications using the connectivity service will have to supply the data store credentials (if they are not saved in the Data Source) in addition to the Data Source name and the credentials for the DataDirect Cloud account.
By default, the characters in the Password field you type are not shown. If you want the password to be displayed in clear text, click the eye Watchful eye password button button. Click the button again to conceal the password.
Host Name
Specifies the path to the SugarCRM instance. Examples include:
*http://localhost/
*https://crm.mycompany.com/production/sugarcrm
Default: None
OAuth Client ID
Specifies a unique OAuth client Id value for the connection. Each connection must have a unique client Id value. If a second connection is made using the same OAuth client Id, even with another user name, the SugarCRM service may opt to invalidate the access token of the first connection.
OAuth Client Secret
Specifies the OAuth client shared-secret phrase. The client shared-secret provides credentials between the OAuth server, SugarCRM, and the OAuth client, the DataDirect Cloud connectivity service. SugarCRM supports an empty client secret, although this practice is not recommended.
OAuth Refresh Token
Specifies the OAuth refresh token value.
When used with the clientId and clientSecret, the refresh token provides an alternative method for using OAuth to connect to SugarCRM. In this case, the login behaves just like a relogin, to fetch the access token using the refresh token. If the refresh token is passed, the username and password are ignored, as they are derived from the login the refresh token is associated with.

Security tab

Click the thumbnail to view the screen.
Security tab of the SugarCRM data source setup dialog (on-premise)Security tab of the SugarCRM data source setup dialog (on-premise)
Table 159. Security tab connection parameters for SugarCRM
Field
Description
Authentication Method
Determines which authentication method the DataDirect Cloud connectivity service uses when it establishes a connection.
Valid Values:
Auto | OAuth | UserIDPassword
If set to Auto, the DataDirect Cloud connectivity service first attempts to use the UserIDPassword method, if sufficient credentials are supplied. If a user ID and password are not specified or are not accepted, the DataDirect Cloud connectivity service tries again using the refreshToken, if supplied. If neither method is successful, the DataDirect Cloud connectivity service throws an exception.
If set to OAuth, the DataDirect Cloud connectivity service uses only the refresh token method.
If set to UserIDPassword, the DataDirect Cloud connectivity service uses user ID/password authentication. The DataDirect Cloud connectivity service sends the user ID and password in clear text to the SugarCRM server for authentication. If a user ID and password are not specified, the DataDirect Cloud connectivity service throws an exception.
*The User Id parameter provides the user ID. The Password parameter provides the password. The Encryption Method parameter determines whether the DataDirect Cloud connectivity service uses data encryption.
Default: Auto
Encryption Method
Determines whether data is encrypted and decrypted when transmitted over the network between the DataDirect Cloud connectivity service and the on-premise database server. Note that when using the SugarCRM-hosted version of SugarCRM, as opposed to a locally-installed copy, this will always be SSL, since sugarcrm.com instances always use SSL encryption.
Valid Values:
noEncryption | SSL
If set to noEncryption, data is not encrypted or decrypted.
If set to SSL, data is encrypted using SSL. If the database server does not support SSL, the connection fails and the DataDirect Cloud connectivity service throws an exception.
Default: SSL

Mapping tab

To see a larger view of the screenshot of the Mapping tab, click the thumbnail; or, right-click the thumbnail and select an option to open the thumbnail in a different window or tab.
Mapping tab of the SugarCRM data source setup dialog (on-premise)Mapping tab of the SugarCRM data source setup dialog (on-premise)
Table 160. Mapping tab connection parameters for SugarCRM
Field
Description
Create Mapping
Determines whether the SugarCRM table mapping files are to be (re)created.
DataDirect Cloud automatically maps cloud data store objects and fields to tables and columns the first time that it connects to the data store. The map includes both standard and custom objects and includes any relationships defined between objects.
Table 160. Valid values for Create Map field
Value
Description
Not Exist
Select this option for most normal operations. If a map for a data source does not exist, this option causes one to be created. If a map exists, the service uses that existing map. If a name is not specified in the Map Name field, the name will be a combination of the User Name and Data Source ID.
Force New
Select this option to force creation of a new map. A map is created on connection whether one exists or not. The connectivity service uses a combination of the User Name and Data Source ID to name the map. Map creation is expensive, so you will likely not want to leave this option set to Force New indefinitely.
No
If a map for a data source does not exist, the connectivity service does not create one.
Map Name
Optional name of the map definition that DataDirect Cloud uses to interpret the schema of the cloud data store. The DataDirect Cloud service automatically creates a name for the map.
If you want to name the map yourself, enter a unique name.
Refresh Schema
The Refresh Schema checkbox specifies whether the connectivity service attempts to refresh the schema when an application first connects.
Valid Values:
When the check box is selected (set to true), the connectivity service attempts to refresh the schema.
When the check box is not selected (set to false), the connectivity service does not attempt to refresh the schema.
Default
false
Notes
*You can choose to refresh the schema by clicking the Refresh button: This refreshes the schema immediately. Note that the refresh option is available only while editing the Data Source.
*Use the checkbox to specify whether the connectivity service attempts to refresh the schema when an application first connects. Use the button if you want to refresh the schema immediately, using an already saved configuration.
*If you are making other edits to the settings, you need to click update to save your configuration. The Refresh schema button will only trigger a runtime call on the saved configuration.

OData tab

The following table describes the controls on the OData tab. For information on using the Configure Schema editor, see Enabling OData and working with Data Source groups and Using the Configure Schema editor. For information on formulating OData requests, see Formulating queries
Click the thumbnail to view the screen. Required fields are marked with an asterisk.
OData tabOData tab
Table 162. OData tab connection parameters for SugarCRM On-Premise
Field
Description
Access URI
Specifies the base URI for the OData feed to access your DataDirect Cloud data source, for example, https://service.datadirectcloud.com/api/odata. You can copy the URI and paste it into your application's OData configuration.
The URI contains the case-insensitive name of the data source to connect to, and the query that you want to execute. This URI is the OData Service Root URI for the OData feed. The Service Document for the data source is returned by issuing a GET request to the data source's service root.
The OData Service Document returns the names of the entities exposed by the Data Source OData service. To get details such as the properties of the entities exposed, the data types for those properties and the relationships between entities, the Service Metadata Document can be fetched by adding /$metadata to the service root URI.
Schema Map
Enables OData support. If a schema map is not defined, the OData API cannot be used to access the data store using this Data Source definition. Use the Configure Schema editor to select the tables to expose through OData.
See Using the Configure Schema editor for more information.
Data Source Caching
Specifies whether the connection to the backend data source is cached in a session associated with the data source. Caching the back end connection improves performance when multiple OData queries are submitted to the same data source because the connection does not need to be created on every query.
Caching of the back end connection can get in the way when trying to configure a data source for OData. If a change is made to any of the DataDirect Cloud data source connection parameters, those changes will not be seen because the connection was established using the old data source definition, and was cached. The session that caches the backend connection is discarded if there is no activity to the data source for approximately 5 minutes.
When you configure a data source for OData, it is recommended that the OData session caching be disabled. Once you are satisfied with the OData configuration for the data source, enable the parameter to get the performance improvement provided by caching the connection to the backend data source.
Valid Values:
When set to 1, session caching is enabled. This provides better performance for production.
When set to 0, session caching is disabled. Use this value when you are configuring the data source.
Default: 1
Page Size
Determines the number of entities returned on each page for paging controlled on the server side. On the client side, requests can use the $top and $skip parameters to control paging. In most cases, server side paging works well for large data sets. Client side pagination works best with a smaller data sets where it is not as expensive to fetch subsequent pages.
Valid Values: 0 | n
where n is an integer from 1 to 10000.
When set to 0, the server default of 2000 is used.
Default: 0
Refresh Result
Controls what happens when you fetch the first page of a cached result when using Client Side Paging. Skip must be omitted or set to 0. You can use the cached copy of that first page, or you can re-execute the query to get a new result, discarding the previously cached result. Re-executing the query is useful when the data being fetched may change between two requests for the first page. Using the cached result is useful if you are paging back and forth through results that are not expected to change.
Valid Values:
When set to 0, the OData service caches the first page of results.
When set to 1, the OData service re-executes the query.
Default: 1
Inline Count Mode
Specifies how the connectivity service satisfies requests that include the $inlinecount parameter when it is set to allpages. These requests require the connectivity service to include the total number of entities that are defined by the OData query request. The count must be included in the first page in server-driven paging and must be included in every page when using client-driven paging.
The optimal setting depends on the data store and the size of results. The OData service can run a separate query using the count(*) aggregate to get the count, before running the query used to generate the entities. In very large results, this approach can often lead to the first page being returned faster. Alternatively, the OData service can fetch the entire result before returning the first page. This approach works well for small results and for data stores that cannot optimize the count(*) aggregate; however, it may have a longer initial response time for the first page if the result is large.
Valid Values:
When set to 1, the connectivity service runs a separate count(*) aggregate query to get the count of entities before executing the query to return results. In very large results, this approach can often lead to the first page being returned faster.
When set to 2, the connectivity service fetches all entities before returning the first page. For small results, this approach is always faster. However, the initial response time for the first page may be longer if the result is large.
Default: 1
Top Mode
Indicates how requests typically use $top and $skip for client side pagination, allowing the service to better anticipate how to process queries.
Valid Values:
Set to 0 when the application generally uses $top to limit the size of the result and rarely attempts to get additional entities by combining $top and $skip.
Set to 1 when the application uses $top as part of client-driven paging and generally combines $top and $skip to page through the result.
Default: 0
OData Read Only
Controls whether write operations can be performed on the OData service. Write operations generate a 405 Method Not Allowed response if this option is enabled.
Existing OData-enabled data sources are read only (write operations are disabled). To enable write operations for an existing OData enabled data source, clear the OData Read Only option on the OData tab. Then, on the Data Sources tab, regenerate the OData model for the data source by clicking on the OData model icon Synch completed successfully.
Valid Values:
true | false
When the check box is selected (set to true), OData access is restricted to read-only mode.
When the check box is not selected (set to false), write operations can be performed on the OData service.
Default: false

Advanced tab

Click the thumbnail to view the screen.
Advanced tab of the SugarCRM data source setup dialog (on-premise)Advanced tab of the SugarCRM data source setup dialog (on-premise)
Table 163. Advanced tab connection parameters for SugarCRM
Field
Description
Extended Options
Specifies a semi-colon separated list of connection options and their values. Use this configuration option to set the value of undocumented connection options that are provided by Progress DataDirect technical support. You can include any valid connection option in the Extended Options string, for example:
Database=Server1;UndocumentedOption1=value[;UndocumentedOption2=value;]
If the Extended Options string contains option values that are also set in the setup dialog, the values of the options specified in the Extended Options string take precedence.
Valid Values: string
Default: empty string
Initialization String
A semicolon delimited set of commands to be executed on the cloud data store after DataDirect Cloud has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and DataDirect Cloud returns an error indicating which SQL commands failed.
Syntax:
SQLcommand[[; SQLcommand]...]
where:
SQLcommand is a SQL command. Multiple commands must be separated by semicolons.
The default is an empty string.
Max Pooled Statements
The maximum number of prepared statements to cache for this connection. If the value of this property is set to 20, the connectivity service caches the last 20 prepared statements that are created by the application.
The default value is 0.
Web Service Call Limit
The maximum number of Web service calls allowed to the cloud data store for a single SQL statement or metadata query.
When set to 0, there is no limit on the number of Web service calls on a single connection that can be made when executing a SQL statement.
The default value is 0.
Web Service Fetch Size
Specifies the number of rows of data the DataDirect Cloud connectivity service attempts to fetch for each call.
Valid Values:
0 | x
If set to 0, the DataDirect Cloud connectivity service attempts to fetch up to a maximum of 10000 rows. This value typically provides the maximum throughput.
If set to x, the DataDirect Cloud connectivity service attempts to fetch up to a maximum of the specified number of rows. Setting the value lower than 10000 can reduce the response time for returning the initial data. Consider using a smaller value for interactive applications only.
Default: 0
Web Service Retry Count
The number of times to retry a timed-out Select request. The Web Service Timeout parameter specifies the period between retries. A value of 0 for the retry count prevents retries. A positive integer sets the number of retries. The default value is 2.
Web Service Timeout
The time, in seconds, to wait before retrying a timed-out Select request. Valid only if the value of Web Service Retry Count is greater than zero. A value of 0 for the timeout waits indefinitely for the response to a Web service request. There is no timeout. A positive integer is considered as a default timeout for any statement created by the connection. The default value is 120.
See the steps for:
Creating a Data Source definition