How to Connect DBeaver to MYOB AccountRight via a JDBC Driver

The CData JDBC Driver for MYOB AccountRight implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to MYOB AccountRight data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for MYOB AccountRight Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for MYOB AccountRight).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.myob.MYOBDriver.
   • Set URL Template to jdbc:myob:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.MYOB.jar).

Create a Connection to MYOB AccountRight Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for MYOB AccountRight) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   These properties are required when connecting to a company file (both for Cloud and On-Premise instances).

   • CompanyFileId: You can find this by starting MYOB, opening your data file, and selecting Help -> About MYOB
   • User: The username associated with your company file.
   • Password: The password associated with your company file.

   Connecting to a Cloud Instance

   To connect to a cloud instance of MYOB, you can use the embedded OAuth credentials or create an OAuth app with MYOB. This process is detailed in the Help documentation.

   Connecting to an On-Premise instance:

   When connecting to an on-premise instance, you will need to set the following connection property in addition to those above:

   • InitiateOauth: Set this to OFF.
   • Url: The Url of your MYOB instance.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the MYOB AccountRight JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.myob.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Below is a typical connection string:

   jdbc:myob:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword; InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query MYOB AccountRight Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial