Build Sage 300-Connected Apps in Mendix
Mendix is a high-productivity app platform that allows you to build and maintain both mobile and web applications at-scale. When paired with CData Connect AI, Mendix provides instant, cloud-to-cloud access to Sage 300 data for applications. This article demonstrates how to connect to a CData Connect AI data source from within Mendix.
CData Connect AI provides a pure cloud-to-cloud interface for Sage 300, allowing you to import data from live Sage 300 data in Mendix — without replicating the data to a natively supported database. As you build web and mobile applications from within Mendix, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Sage 300, leveraging server-side processing to return the requested Sage 300 data quickly.
Configure Sage 300 Connectivity for Mendix
To work with Sage 300 data from Mendix, we need to connect to Sage 300 from Connect AI, provide user access to the connection, and create a Workspace for the Sage 300 data.
Connect to Sage 300 from Connect AI
CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "Sage 300" from the Add Connection panel
-
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.
- Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the
- Click Save & Test
-
Navigate to the Permissions tab in the Add Sage 300 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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
Configure Sage 300 Endpoints for Mendix
After connecting to Sage 300, create a workspace for your desired table(s).
-
Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
- Click Add to add new assets to the Workspace.
-
Select the Sage 300 connection (e.g. Sage3001) and click Next.
-
Select the table(s) you wish to work with and click Confirm.
- Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
With the connection, PAT, and Workspace configured, you are ready to connect to Sage 300 data from Mendix.
Build a Sage 300-Connected App
Downloading the OData Metadata File
When creating a connection in Mendix, the connection flow requires a Data Source Contract File. Follow these steps to download the OData metadata file for CData Connect AI using curl, a command line tool:
- Open a command-line window for your operating system. On Windows, open the start menu, type cmd, and press the Enter key to open a command prompt. On macOS and Linux, open a Terminal window.
- To check if curl is installed on your system, type curl -help and press the enter key. If it is not installed, install it from the curl website.
-
Issue the following curl command, replacing USER with your CData Connect AI username and PAT with the PAT you generated above:
curl -u USER:PAT https://cloud.cdata.com/api/odata/{workspace_name}/$metadata -o metadata.xml - Locate the metadata.xml file that the curl command created and move it to an accessible location.
Connecting to CData Connect AI in Mendix
Follow these steps to establish a connection from Mendix to CData Connect AI:
- Login to Mendix and open the Data Hub page.
- In the Register a Data Source section, select OData.
- Upload the metadata.xml file from the steps above and click Next.
- Enter your desired values for Data Source Name and Data Source Version. In the Data Source Relative Path field, enter /api/odata/{workspace_name} and click Next.
- On the Application information page, click Register a new application.
- Enter a name in Application Name and select a technical owner (by default, this is the user who is currently logged in).
- Click Next. In the Environment Name field, enter a desired name (for example, CData Connect AI). In the Environment Location field, enter https://cloud.cdata.com and select the appropriate Environment Type (e.g. Production), depending on what is needed.
- Click Done! to create your connection.
You can now use your connection in Mendix Studio Pro to easily create applications with access to live Sage 300 data.
Get CData Connect AI
To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!