- Starter
- Business
- Enterprise
- On-Premise
- Add-on
Overview
Etlworks SuiteCRM connector allows the fastest and easiest way to connect to real-time SuiteCRM data. The connector works just like any other connector for connected app.
Etlworks partnered with CData to provide access to SuiteCRM using industry-standard JDBC protocol. Read about CData SuiteCRM JDBC connector.
When to use SuiteCRM connector
Use this connector to create Flows that extract data and load data into SuiteCRM.
Prerequisites
Install the connector and start a trial directly from Etlworks (Etlworks 10.0.14 and newer) — see Install and license the connector below. On older versions, contact support@etlworks.com to enable the connector for your account.
Create a Connection
You can create a Connection in just two steps, and they are the following:
Step 1. In the Connections window, click +, and type in suite crm. Select Suite CRM.
Step 2. Enter the Connection parameters:
- SuiteCRM URL: the server URL.
- User: the user name.
- Password: the password.
Use Other Parameters to specify the Connection string options. Read about available Connection string options.
Work with SuiteCRM
SuiteCRM Online Data Model
The connector models SuiteCRM modules as the relational database.
Read about the data model.
SQL Compliance
The connector supports several operations on data, including querying, deleting, modifying, and inserting.
Read about SQL Compliance.
Extract data from SuiteCRM
Note: Extracting data from SuiteCRM is similar toextracting data from the relational database.
Here are the steps on how you can extract data from SuiteCRM:
Step 1. Create SuiteCRM Connection, which will be used as a source (FROM).
Step 2. Create a destination Connection, for example, a Connection to the relational database, and if needed, a Format (Format is not needed if the destination is a database or well-known API).
Step 3. Create a Flow where the source is a connected app, and the destination is a Connection created in step 2, for example, a relational database.
Step 4. Add a new source-to-destination transformation.
Step 5. Select the SuiteCRM Connection created in step 1 as a source Connection and select the data object you are extracting data from.
Step 6. Select TO Connection, Format (if needed), and object (for example, database table) to load data into.
Step 7. Click MAPPING and optionally enter Source query (you don't need a query if you are extracting data from the SuiteCRM data object unconditionally).
Step 8. Optionally define the per-field Mapping.
Step 9. Add more transformations if needed.
Load data in SuiteCRM
Note: Loading data in SuiteCRM is similar toloading data into a relational database.
Here are the steps on how you can load data in SuiteCRM:
Step 1. Create a source Connection and a Format (if needed).
Step 2. Create a destination SuiteCRM Connection.
Step 3. Create a Flow where the destination is a connected app.
Step 4. Add new source-to-destination transformation.
Step 5. Select FROM and TO Connections and objects (also a FROM Format, if needed).
Step 6. Optionally define the per-field Mapping.
Step 7. Add more transformations if needed.
Browse data in SuiteCRM
You must have SuiteCRM Connection to browse objects and run SQL queries.
Use the Etlworks Explorer to browse data and metadata in SuiteCRM as well as execute DML and SELECT queries against the SuiteCRM Connection.
Install and license the connector
This is a premium connector (Etlworks 10.0.14 and newer).
- Open a connection of this type (or Settings → Premium connectors) and click Download and install.
- Click Start trial to evaluate it.
- For production, contact Etlworks support for a license key or runtime key, then click Activate license.
Read more: Managing premium connectors.