Create CSV-Connected Enterprise Applications in OutSystems

OutSystems is a low-code platform which provides the tools for companies to developer, deploy, and manage omnichannel enterprise applications. When paired with CData Connect AI, you get instant, cloud-to-cloud access to CSV data for business applications. This article shows how to create a virtual database for CSV in Connect AI and build a simple app from CSV data in OutSystems.

The CData Connect AI provides a pure cloud-to-cloud interface for CSV, allowing you to build reports from live CSV data in OutSystems — without replicating the data to a natively supported database. As you create applications to work with data, OutSystems generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to CSV, leveraging server-side processing to quickly return the requested CSV data.

Configure CSV Connectivity for OutSystems

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

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

2. Select "CSV" from the Add Connection panel

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

   Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) CSV Files

   CData Drivers let you work with CSV files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

   Setting connection properties for local files

   Set the URI property to local folder path.

   Setting connection properties for files stored in Amazon S3

   To connect to CSV file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended CSV files exist. In addition, at least set these properties:

   • AWSAccessKey: AWS Access Key (username)
   • AWSSecretKey: AWS Secret Key

   Setting connection properties for files stored in Box

   To connect to CSV file(s) within Box, set the URI property to the URI of the folder that includes the intended CSV file(s). Use the OAuth authentication method to connect to Box.

   Dropbox

   To connect to CSV file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended CSV file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

   SharePoint Online (SOAP)

   To connect to CSV file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended CSV file. Set User, Password, and StorageBaseURL.

   SharePoint Online REST

   To connect to CSV file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended CSV file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

   Google Drive

   To connect to CSV file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended CSV file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add CSV 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 CSV data from OutSystems.

Connect to CSV from OutSystems

The steps below outline connecting to CData Connect AI from OutSystems to create a new CSV database connection.

1. Open OutSystems Service Studio
2. Click the gear icon to open Environment Management in the Service Center
3. Click Administration and select "Database Connections"
4. Click "New Database Connection"
5. Configure the database connection:
   • Name: name the connection (e.g. CData Connect AI CSV)
   • DBMS: SQL Server / Azure SQL
   • Username: a Connect AI user (e.g. [email protected])
   • Password: the PAT for the Connect AI user
   • Server: tds.cdata.com,14333
   • Schema: the name of your CSV connection (e.g. CSV1)
   
6. Click "Test Connection"
7. Click "Create"

Map CSV Tables or Views to Entities in an Extension Module

Once you create the database connection for CSV, you can create an extension that maps the tables or views to OutSystems entities. If you have not already done so, create an Application in Service Studio.

1. Open the Service Studio and open the existing Application
2. Click "Add Module," set the "Module Name" (e.g. csv_db_extension), set "Module Type" to "Extension," and click "Create Module"
3. In Integration Studio, connect to your environment
4. Right-click "Entities" in the extension tree and select "Connect to External Table or View..."
5. Follow the steps in the wizard, selecting the tables and views you wish to work with
6. In the Integration Studio, click "1-Click Publish"
7. In the "1-Click Publish" wizard, click "Configure" when the process completes
   • In the Service Center, associate the logical database name of the extension to the database connection that the extension will use and click "Apply"
8. In your application, click "Manage Dependencies..."
9. Add a dependency to the Extension and select the Entities that you will use in your application

At this point, you can access and work with CSV data just like you would with the standard OutSystems entities.

Get CData Connect AI

With Connect AI and OutSystems, you can easily build CSV-connected applications. Request a free trial of Connect AI and start working with CSV data in OutSystems today.