|
Field
|
Description
|
|
Data Source Name
|
A unique name for the data source. Data source names can contain only alphanumeric characters, underscores, and dashes.
|
|
Description
|
A general description of the data source.
|
|
User Id, Password
|
The login credentials for your SugarCRM cloud data store account.
Hybrid Data Pipeline 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 Hybrid Data Pipeline 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
 icon. Click the icon 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 Hybrid Data Pipeline 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.
|
|
Connector ID
|
The unique identifier of the On-Premise Connector that is to be used to access the on-premise data source. Select the Connector that you want to use from the dropdown. 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-Premise 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 dropdown were shared with you, the owner's name is appended, for example, Production(owner1) and Production(owner2).
|
|
Field
|
Description
|
|
Authentication Method
|
Determines which authentication method the Hybrid Data Pipeline connectivity service uses when it establishes a connection.
Valid Values:
Auto | OAuth | UserIDPassword
If set to Auto, the 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 Hybrid Data Pipeline connectivity service tries again using the refreshToken, if supplied. If neither method is successful, the connectivity service throws an exception.
If set to OAuth, the Hybrid Data Pipeline connectivity service uses only the refresh token method.
If set to UserIDPassword, the Hybrid Data Pipeline connectivity service uses user ID/password authentication. The 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 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 Hybrid Data Pipeline connectivity service uses data encryption.
Default: Auto
|
|
Encryption Method
|
Determines whether data is encrypted and decrypted when transmitted over the network between the Hybrid Data Pipeline 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 Hybrid Data Pipeline connectivity service throws an exception.
Default: SSL
|
|
Field
|
Description
|
||||||||
|
Map Name
|
Optional name of the map definition that the Hybrid Data Pipeline connectivity service uses to interpret the schema of the data store. The Hybrid Data Pipeline 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 option specifies whether the connectivity service attempts to refresh the schema when an application first connects.
Valid Values:
When set to ON, the connectivity service attempts to refresh the schema.
When set to OFF, the connectivity service does not attempt to refresh the schema.
Default
OFF
Notes
You can choose to refresh the schema by clicking the Refresh
 icon. This refreshes the schema immediately. Note that the refresh option is available only while editing the data source.
Use the option to specify whether the connectivity service attempts to refresh the schema when an application first connects. Click the Refresh icon 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. Clicking the Refresh icon will only trigger a runtime call on the saved configuration.
|
||||||||
|
Create Mapping
|
Determines whether the SugarCRM table mapping files are to be (re)created.
The Hybrid Data Pipeline connectivity service automatically maps 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.
|
|
Field
|
Description
|
|
Version
|
Enables you to choose from the supported OData versions. OData configuration made with one OData version will not work if you switch to a different OData version. If you want to maintain the data source with different OData versions, you must create different data sources for each of them.
|
|
Access URI
|
Specifies the base URI for the OData feed to access your data source, for example, https://hybridpipe.operations.com/api/odata/<DataSourceName>. 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/columns to expose through OData.
See Configuring data sources for OData connectivity and working with data source groups for more information.
|
|
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 $count parameter when it is set to true (for OData version 4) or the $inlinecount parameter when it is set to allpages (for OData version 2). 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
|
|
Field
|
Description
|
|
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.
|
|
Initialization String
|
A semicolon delimited set of commands to be executed on the data store after Hybrid Data Pipeline has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and Hybrid Data Pipeline returns an error indicating which SQL commands failed.
Syntax:
command[[; command]...]
Where:
command
is a SQL command. Multiple commands must be separated by semicolons. In addition, if this property is specified in a connection URL, the entire value must be enclosed in parentheses when multiple commands are specified. For example, assuming a schema name of SFORCE:
InitializationString=(REFRESH SCHEMA SFORCE)
The default is an empty string.
|
|
Web Service Call Limit
|
The maximum number of Web service calls allowed 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 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.
|
|
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 Fetch Size
|
Specifies the number of rows of data the Hybrid Data Pipeline connectivity service attempts to fetch for each call.
Valid Values:
0 | x
If set to 0, the connectivity service attempts to fetch up to a maximum of 10000 rows. This value typically provides the maximum throughput.
If set to x, the Hybrid Data Pipeline 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
|
|
Extended Options
|
Specifies a semi-colon delimited 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
|
|
Metadata Exposed Schemas
|
Restricts the metadata exposed by Hybrid Data Pipeline to a single schema. The metadata exposed in the SQL Editor, the Configure Schema Editor, and third party applications will be limited to the specified schema. JDBC, OData, and ODBC metadata calls will also be restricted. In addition, calls made with the Schema API will be limited to the specified schema.
Warning: This functionality should not be regarded as a security measure. While the Metadata Exposed Schemas option restricts the metadata exposed by Hybrid Data Pipeline to a single schema, it does not prevent queries against other schemas on the backend data store. As a matter of best practice, permissions should be set on the backend data store to control the ability of users to query data.
Valid Values
<schema>
Where:
<schema>
is the name of a valid schema on the backend data store.
Default: No schema is specified. Therefore, all schemas are exposed.
|