Setting Up a SugarCRM REST Connection Manager
The REST Connection Manager is an SSIS connection manager that can be used to establish connections and facilitate data integration with REST based APIs and services such as SugarCRM, among many more.
Integration for SugarCRM is enabled by the following two components:
To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "REST (KingswaySoft)" item to add a new REST Connection Manager.
The REST Connection Manager contains 2 pages of configuration.
- General
- Advanced Settings
General Page
The General page allows you to specify connection properties and login credentials for the SugarCRM REST service:
- Service Name
-
The REST service that will be connected to.
- Base URL
-
The Base URL of the SugarCRM service, which is the site URL of the SugarCRM system.
- REST Version
-
The REST Version of the SugarCRM service endpoint that will be connected to. Clicking the Get Latest button will automatically populate the REST Version.
- Client Id
-
The Client Id (Consumer Key) that will be used to request SugarCRM OAuth Token, which can be created by the SugarCRM administrator in the OAuth Keys section in the Administration section.
- Client Secret
-
The Client Secret (Consumer Secret) that will be used to request SugarCRM OAuth Token, which can be created by the SugarCRM administrator in the OAuth Keys section in the Administration section along with the Client Id (Consumer Key).
- Username
-
The Username of the SugarCRM user authenticating to the system.
- Password
-
The Password of the user authenticating to the system.
- Platform
-
The Platform allows you to specify an identifiable string to describe and identify your current integration, which is default to SSIS.
- Test Connection
-
After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.
Advanced Settings Page
- Proxy Mode
-
The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.
- No Proxy
- Auto-detect (Using system-configured proxy)
- Manual
- Proxy Server
-
Using the Proxy Server option allows you to specify the name of the proxy server for the connection.
- Port
-
The Port option allows you to specify the port number of the proxy server for the connection.
- Username (Proxy Server Authentication)
-
The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.
- Password (Proxy Server Authentication)
-
The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.
Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.
- Timeout
-
The number of seconds requests should wait before timing out.
- Retry on Intermittent Errors
-
The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.
- Ignore Certificate Errors
-
This option can be used to ignore those SSL certificate errors when connecting to SugarCRM servers.
Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.