Build SuiteCRM-Connected Apps in Choreo

The Choreo platform from WS02 is a versatile platform designed for low-code and cloud-native engineering. Developers, even those without advanced coding skills, can leverage Choreo's user-friendly low-code environment to simplify application development. When combined with CData Connect AI, users gain immediate cloud-to-cloud access to SuiteCRM data for applications. This article details the process of connecting to SuiteCRM using Connect AI and building an application with real-time access to SuiteCRM data within Choreo.

CData Connect AI delivers a pure cloud-to-cloud interface for SuiteCRM, enabling you to construct applications within Choreo that utilize live SuiteCRM data data, all without the need for data replication to a natively supported database. With its built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, directly to SuiteCRM, capitalizing on server-side processing to swiftly provide the requested SuiteCRM data.

Configure SuiteCRM Connectivity for Choreo

Connectivity to SuiteCRM from Choreo is made possible through CData Connect AI. To work with SuiteCRM data from Choreo, we start by creating and configuring a SuiteCRM connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "SuiteCRM" from the Add Connection panel

3. Enter the necessary authentication properties to connect to SuiteCRM.

   The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

   Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add SuiteCRM Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to SuiteCRM data from Choreo.

Connect to SuiteCRM from Choreo

The steps below outline connecting to CData Connect AI from Choreo to create a new application with access to live SuiteCRM data.

Creating a Construct

1. Sign in to the Choreo platform. Note: This article is from the perspective of an Anonymous user.
2. Select Components from the left sidebar and then click +Create. Next, choose Manual Trigger and then Start from scratch.
3. Give the manual trigger a Name and Description and click Create.
4. After the trigger is created, click on Edit Code.
5. The Ballerina Low-Code IDE is displayed. Choreo automatically generates a construct in the low-code diagram view. Delete this construct by highlighting it and clicking on the trashcan icon.
6. Click the + icon towards the top of the screen and select Main from the Add Constructs toolbar on the right. In the following Function Configuration form, click Save.

Adding the CData Connect AI Connector

1. Click the + icon between the Start and End ellipses and click Connector.

2. In the Connectors sidebar on the right, search for "CData". Click CData Connect to open the Connector settings pane.

3. In the Connector settings pane, enter the configuration settings:
   • Enter an Endpoint Name for your use. In this example, we use "connectEndpoint".
   • In the User field, enter the email address of the CData Connect AI user, wrapped in quotation marks (for example, "[email protected]").
   • In the Password field, enter the PAT you generated earlier, wrapped in quotation marks (for example, "SampleToken").

4. After clicking Save, the low-code editor appears with the CData Connect AI logo.

Adding a Query Action

1. Click the + icon between the new and end shapes, select Action, and then select our existing connector endpoint.

2. Select query for the connector Operation. There is now an Action pane on the right.

3. Enter a SQL query to retrieve SuiteCRM data as the sqlQuery parameter for the query. For example:

   
   			SELECT * FROM SuiteCRM1.SuiteCRM.Accounts LIMIT 10
   		

   • When writing the query, be sure to specify the Connection Name as the catalog and Data Source Name as the schema. For example, SuiteCRM1.SuiteCRM.
   • These parameters appear on the Connections page of your CData Connect AI dashboard.

Iterating over SuiteCRM Data

1. Click the Show Source icon in the top right of the code editor.
2. Add an import statment to import the ballerina/io library:

   		
   		import ballerina/io;
   	

3. Next, add a from statement after the query action to iterate through the results of the SQL query:

		
		check from record{} result in resultStream
		do {
			io:println("Full Accounts details: ", result);
		};
	

4. The code for the construct will now look similar to this:

			
			import ballerinax/cdata.connect;
			import ballerinax/cdata.connect.driver as _;
			import ballerina/io;

			public function main() returns error? {
				connect:Client connectEp = check new (user = "connect_cloud_username", password="connect_cloud_pat");

				stream<record {}, error=""?> resultStream =
				connectEp->query(sqlQuery = `SELECT * FROM SuiteCRM1.SuiteCRM.Accounts LIMIT 10`);

				check from record{} result in resultStream
				do {
					io:println("Full Accounts details: ", result);
				};
			}
		

5. Click Save to save the action. The diagram should now look similar to this:

Deploying the Program

Once you have added all of your desired actions to your program, follow these steps:

1. Commit and push your final source code in the web editor and sync those changes with the Choreo platform.
2. Click Deploy in the left navigation bar of the Choreo Console.
3. Under Build Area, click Configure & Deploy to deploy your program.
4. When prompted, enter the same CData Connect AI username and password that you used earlier and click Deploy.

You have now created an application with access to live SuiteCRM data in Choreo.

Get CData Connect AI

For more information about using Choreo with CData Connect AI, see the CData Connect Ballerina Guide. To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!