Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in WordPress.
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 WordPress 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 WordPress 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 WordPress
At this time, CData Tableau Connector for WordPress only supports connecting to self-hosted WordPress instances. To connect to data, supply the Url to your wordpress site, and then authenticate as described below.Supply the URL in its full form. For example, if your site is hosted at http://localhost/wp/wordpress', the URL should be http://localhost/wp/wordpress, and not 'htpp://localhost'. Failure to supply the URL in its full form results in a 'site not found' error.
WordPress supports two types of authentication:
- Basic authentication, which is recommended for use in a testing environment; and
- OAuth 2.0 authentication, which supports browser-based access from a Desktop application, Web application, or Headless Machine.
Basic Authentication
Basic authentication is recommended for testing environments only.Before you configure WordPress to use Basic Authentication:
- Ensure that your WordPress login has adminstrative privileges.
- Know what version of WordPress is running at the local host. (WordPress 4.7 and later support the WordPress REST API natively; earlier versions require the use of a Basic Authentication plug-in to secure access to the REST API.)
To configure Basic Authentication:
- Log into your WordPress host.
- If you are running an earlier WordPress version than 4.7, install the REST API plugin.
- Install the Basic Authentication plugin.
- To create custom taxonomies, install the Simple Taxonomy Refreshed
If you prefer installing the plugins manually, extract the compressed folders to the wp-content\plugins folder and then enable the plugins via the WordPress admin interface. - Set the following connection properties:
- AuthScheme: Basic.
- Url: Your WordPress URL.
- User: Your username.
- Password: Your password.
You are now ready to connect.
OAuth 2.0 Authentication
For all non-testing environments, WordPress supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.The following subsections describe how to authenticate to WordPress from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in WordPress, see Connection.
Desktop Applications
To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.Get and refresh the OAuth access token:
- InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
- OAuthClientId: The client Id assigned when you registered your application.
- OAuthClientSecret: The client secret that was assigned when you registered your application.
- CallbackURL: The redirect URI that was defined when you registered your application.
When you connect, the connector opens WordPress's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector then completes the OAuth process:
- The connector obtains an access token from WordPress 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:
- Before connecting to data for the first time, set the following 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 the following:
- InitiateOAuth
- OAuthSettingsLocation
Next Step
See Using the Connector to create data visualizations.