Create Sage 300-Connected Enterprise Applications in OutSystems

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to Sage 300 Data from OutSystems and build custom enterprise apps using live Sage 300 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 Sage 300 data for business applications. This article shows how to create a virtual database for Sage 300 in Connect AI and build a simple app from Sage 300 data in OutSystems.

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

Configure Sage 300 Connectivity for OutSystems

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

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

    Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

    • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
    • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
    • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

    Authenticate to Sage 300 using Basic authentication.

    Connect Using Basic Authentication

    You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

    • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
    • User: Set this to the username of your account.
    • Password: Set this to the password of your account.
    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Sage 300 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 Sage 300 data from OutSystems.

Connect to Sage 300 from OutSystems

The steps below outline connecting to CData Connect AI from OutSystems to create a new Sage 300 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 Sage 300)
    • 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 Sage 300 connection (e.g. Sage3001)
    Connecting to the Connect AI
  6. Click "Test Connection"
  7. Click "Create"

Map Sage 300 Tables or Views to Entities in an Extension Module

Once you create the database connection for Sage 300, 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. sage300_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
    • In the Service Center, associate the logical database name of the extension to the database connection that the extension will use and click "Apply" Configuring the external extension
  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 Sage 300 data just like you would with the standard OutSystems entities.

Get CData Connect AI

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

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial