How to create Sage 300 federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Sage 300 data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Sage 300: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Sage 300 data just as you would local MySQL tables.

Connect to Sage 300 Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Sage 300 data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Sage 300 Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Sage 300. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedSage300
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Sage300 Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (OEInvoices). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_oeinvoices (
  ...,
  invoiceuniquifier  TYPE(LEN),
  approvedlimit  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedSage300/oeinvoices';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Sage 300 FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Sage 300. Refer to the following example:

SELECT 
  fed_oeinvoices.invoiceuniquifier, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_oeinvoices 
ON 
  local_table.foreign_invoiceuniquifier = fed_oeinvoices.invoiceuniquifier;