VOOZH about

URL: https://www.cdata.com/kb/tech/actcrm-cloud-outsystems.rst

⇱ Create Act CRM-Connected Enterprise Applications in OutSystems


Create Act CRM-Connected Enterprise Applications in OutSystems

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to Act CRM Data from OutSystems and build custom enterprise apps using live Act CRM data.

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 Act CRM data for business applications. This article shows how to create a virtual database for Act CRM in Connect AI and build a simple app from Act CRM data in OutSystems.

The CData Connect AI provides a pure cloud-to-cloud interface for Act CRM, allowing you to build reports from live Act CRM 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 Act CRM, leveraging server-side processing to quickly return the requested Act CRM data.

Configure Act CRM Connectivity for OutSystems

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

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Act CRM" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to Act CRM.

    The and properties, under the Authentication section, must be set to valid Act! user credentials. In addition to the authentication values, see the following:

    • Connecting to Act! Premium

      In addition to the authentication values, the to Act! is also required; for example https://eup1-iis-04.eu.hosted.act.com/.

      Additionally, you must specify the you will connect to. This is found by going to the About Act! Premium menu of your account, at the top right of the page, in the ? menu. Use the Database Name in the window that appears.

    • Connecting to Act! Premium Cloud

      To connect to your Act! Premium Cloud account, you also need to specify the property. This property is found in the URL address of the Cloud account; for example https://eup1-iis-04.eu.hosted.act.com/ActCloudName/.

    Note that retrieving ActCRM metadata can be expensive. It is advised that you set the property to store the metadata locally.

    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Act CRM Connection page and update the User-based permissions. πŸ‘ Updating 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. πŸ‘ Creating a new PAT
  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 Act CRM data from OutSystems.

Connect to Act CRM from OutSystems

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

  1. Open OutSystems Service Studio
  2. Click the gear icon to open Environment Management in the Service Center πŸ‘ Opening 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 Act CRM)
    • 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 Act CRM connection (e.g. ActCRM1)
    πŸ‘ Connecting to the Connect AI
  6. Click "Test Connection"
  7. Click "Create"

Map Act CRM Tables or Views to Entities in an Extension Module

Once you create the database connection for Act CRM, 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. actcrm_db_extension), set "Module Type" to "Extension," and click "Create Module" πŸ‘ Creating a new extension 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..." πŸ‘ Connecting to external tables or views
  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
  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 πŸ‘ Adding a dependency to the extension

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

Get CData Connect AI

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