Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Xero WorkflowMax Data as a Federated Tables in MySQL
Use the SQL Gateway and the ODBC Driver to set up federated tables for Xero WorkflowMax data in MySQL .
You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Xero WorkflowMax data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Xero WorkflowMax: 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 Xero WorkflowMax data just as you would local MySQL tables.
Connect to Xero WorkflowMax 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.
To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).
After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to Xero WorkflowMax 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 Xero WorkflowMax 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 Xero WorkflowMax. 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 fedXeroWorkflowMax FOREIGN DATA WRAPPER mysql OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData XeroWorkflowMax 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 (Clients). Refer to the following template for the statement to create a FEDERATED table:
CREATE TABLE fed_clients ( ..., id TYPE(LEN), name TYPE(LEN), ..., ) ENGINE=FEDERATED DEFAULT CHARSET=latin1 CONNECTION='fedXeroWorkflowMax/clients';
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 Xero WorkflowMax 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 Xero WorkflowMax. Refer to the following example:
SELECT fed_clients.id, local_table.custom_field FROM local_table JOIN fed_clients ON local_table.foreign_id = fed_clients.id;