Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in MYOB.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called MYOB by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for MYOB folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Connecting to MYOB
To connect to a MYOB company file, set CompanyFileId to the ID of the company file you want to retrieve data from. If not specified, the ID of the first returned company file (sorted alphabetically) is used.This connection property is required to access all tables and views, except for the CompanyFiles view, which you can use to view the company files associated with your account (and their associated IDs). Use this view if you don't know the ID of your company file.
Set the following additional properties:
On-premise instance | Instance: Set this to OnPremise. |
AuthScheme: Set this to Basic. | |
User: The username associated with your company file. When you create your company file, a user account called Administrator is automatically created. By default, the Administrator user account doesn't have a password assigned. | |
InitiateOAuth: OFF. | |
Url: The Url of your MYOB instance. | |
Cloud instance | Instance: Set this to Cloud. |
AuthScheme: Set this to OAuth. | |
InitiateOAuth: GETANDREFRESH. | |
User: The username associated with your company file. | |
Password: Set to password of authorized user of company file (if password is set). |
Authenticating to MYOB
MYOB supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.The following subsections describe how to authenticate to MYOB from three common authentication flows:
- Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
- Web: access to data via a shared website. Authenticated via custom OAuth only.
- Headless Server: a dedicated op that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.
For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in MYOB, see Connection.
Desktop Applications
CData provides an embedded OAuth application that simplifies authentication at the desktop. You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the MYOB console. For further information, see Creating a Custom OAuth Application.Before you connect, set these properties:
- InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
- Custom OAuth applications only:
- OAuthClientId: The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
- CallbackURL: The redirect URI defined when you registered your custom OAuth application.
When you connect, the connector opens MYOB's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector completes the OAuth process:
- The connector obtains an access token from MYOB and uses it to request data.
- The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the connector automatically refresh the OAuth access token, do the following:
- The first time you connect to data, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the connector to save the OAuth values, which persist across connections.
- On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAUth access token is the OAuth refresh token.
- To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
- Set these connection properties:
- OAuthClientId: The Client Id in your application settings.
- OAuthClientSecret: The Client Secret in your application settings.
- Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
- After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
Next Step
See Using the Connector to create data visualizations.