
COZYROC SugarCRM components, part of COZYROC SSIS+ suite since 2012, are third-party plug-ins for Microsoft SSIS that make it easy to integrate or migrate data to and from SugarCRM. They will preserve the integrity of your data by always using the recommended SugarCRM SOAP web services API. You can use any application, service or database supported by SQL Server Integration Services (SSIS) or COZYROC’s toolkit as the source or destination for SugarCRM. The toolkit is easy to use and follows the same guidelines and principles used by the standard out-of-the-box SSIS components. In addition, COZYROC also provides short and informative demonstration videos, providing step-by-step instructions on how to get started.
The SugarCRM integration package consists of four parts:
- SugarCRM Connection Manager
- Stores the credentials and functionality for connecting to SugarCRM server.
- Well documented API for use by user-defined scripts.
- SugarCRM Source component
- Retrieves data from a SugarCRM module.
- Ability to specify query or order by clause.
- Ability to retrieve deleted records.
- The source can be dynamically modified at runtime using an SSIS expression.
- SugarCRM Destination component
- Inserts or updates data in SugarCRM module.
- Provides information about records with errors as well as the identifier assigned for new records created.
- Reusable scripts
- Unique technology which allows user-defined reusable scripts for additional SugarCRM integration scenarios.
Overview
SugarCRM Connection Manager is SSIS Connection Manager for establishing SugarCRM connections. Use the API to build components based on SugarCRM Connection Manager.
Parameters
Server
Use the SugarCRM Connection Manager dialog to specify properties for connecting to SugarCRM service.
- Test Connection
- Confirm connection manager configuration by clicking Test Connection.
Specify the name or IP address of the SugarCRM server.
Specify user name to access SugarCRM.
Specify password to access SugarCRM.
Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.
Specify if all clients should use the same connection. This property has the options listed in the following table.
Value Description True All clients use same connection (default). False Every client use different connection.
Proxy
Use the Proxy page of the SugarCRM Connection Manager dialog to specify properties if your server is behind firewall.
Specify the name or IP address of the proxy server. If not specified, proxy server is not used.
Specify the port number on the proxy server to use for the connection.
Specify user name to access the proxy server.
Specify password to access the proxy server.
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
Overview
The SugarCRM Source Component is an SSIS Data Flow Component for consuming data from the SugarCRM Service. The configuration parameters are provided in the standard Data Flow Component dialogs.
Parameters
Configuration
Use the parameters below to configure the component.
Select an existing SugarCRM connection manager.
Related Topics: SugarCRM Connection Manager
Specify the number of rows to be retrieved as a batch.
Select the SugarCRM module.
Specify the WHERE clause. Optional.
Specify the ORDER BY clause. Optional.
Indicate whether or not to include deleted records in the result. This parameter has the options listed in the following table.
Value Description True Include the deleted records in the result. False Do not include the deleted records in the result (default). Indicate whether or not the module relationship fields should be included. This parameter has the options listed in the following table.
Value Description True The relationship fields are included. Keep in mind this may cause the retrieve process to run more slowly. False The relationship fields are not included (default).
Knowledge Base
What's New
- New: Introduced component.
Related documentation
Overview
The SugarCRM Destination Component is an SSIS Data Flow Component for loading data into a SugarCRM module. The configuration parameters are provided in the standard Data Flow Component dialogs.
Parameters
Configuration
Use the parameters below to configure the component.
Select an existing SugarCRM connection manager.
Related Topics: SugarCRM Connection Manager
Specify the destination SugarCRM module where the data is loaded.
Specify the number of rows to be sent as a batch.
Specify how to handle rows with errors.
Contains the unique identifier of the updated record.
Knowledge Base
What's New
- New: Introduced component.
Related documentation
Overview
These public interfaces are used in SugarCRM components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and CozyRoc.SugarCRM.dll libraries. Also include CozyRoc.SqlServer.SSIS, CozyRoc.SugarCrm and CozyRoc.SugarCrm.Service namespaces.
IConnection / ISugarCrmConnection
When you call SugarCRM Connection Manager AcquireConnection method, it returns object implementing IConnection interface. This is the interface used for interaction with SugarCRM service.
Methods
Connects to SugarCRM service. The method result is object implementing SugarCRM Core Calls.
Closes the connection to SugarCRM service. Use always after you finish working with the service.
Returns true if connected to the service.
Returns session identifier of connection.
Properties
Specify the name or IP address of the SugarCRM server.
Specify user name to access the SugarCRM service.
Specify user password to access the SugarCRM service.
Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.
Specify if all clients should use the same connection. This property has the options listed in the following table.
Value | Description |
---|---|
True | All clients use same connection (default). |
False | Every client uses different connection. |
Specify the name or IP address of the proxy server.
Specify the port number on the proxy server to use for the connection.
Specify user name to access the proxy server.
Specify password to access the proxy server.
Knowledge Base
Related documentation
Knowledge Base
- Where can I find the documentation for the SugarCRM Connection?
- Where can I find the documentation for the SugarCRM Destination?
- Where can I find the documentation for the SugarCRM Source?
- Where can I find the documentation for the SugarCRM Connection?
- How to delete a module record
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.