diff --git a/doc/changes/changes_0.1.0.md b/doc/changes/changes_0.1.0.md index 0e6e9ce..3e5cce3 100644 --- a/doc/changes/changes_0.1.0.md +++ b/doc/changes/changes_0.1.0.md @@ -1,12 +1,11 @@ -# tableau-connector 0.1.0, released 2021-??-?? +# Exasol Tableau Connector 0.1.0, released 2021-07-15 -Code name: Green original tests +Code name: Additional functions support, optimized metadata fetching ## Summary -Version 0.1.0 of the Tableau Connector brings the connector embedded into Exasol's standard project layout. Also the existing test with the TDVT test suite provided by Tableau can now be executed. Test failures have been fixed. - -Note that this version is not considered production-ready, since it has only been tested using Tableau's TDVT test suite. Tests on Tableau server have not yet been conducted. +Version 0.1.0 of the Tableau Connector brings the connector embedded into Exasol's standard project layout. The release contains a few bug fixes and improvements, including optimized metadata fetching, and a few additional functions enabled. +The connector was tested with the TDVT test framework and also with freshly added integration tests for the Tableau Server application. ## Features @@ -24,4 +23,5 @@ Note that this version is not considered production-ready, since it has only bee ## Documentation -* #1: Added changelog and README +* #1: Added changelog and README. +* #20: Added a user guide. diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md index 5bbf7a1..8c3bd82 100644 --- a/doc/user_guide/user_guide.md +++ b/doc/user_guide/user_guide.md @@ -1 +1,55 @@ -TDB \ No newline at end of file +# User Guide + +The Exasol Tableau Connector is distributed together with Tableau Desktop and Tableau Server applications. We recommend using the latest available version of Tableau products to access the connector. +If you want to use the currently developed version of connector, you can follow the guide below and install the connector disabling sign verification. + +## Testing In-Development Connector + +## With Tableau Desktop + +* Clone the Tableau-Connector repository. You can execute the following command from [Git Bash](https://gitforwindows.org/) terminal: + + ```shell + git clone https://github.com/exasol/tableau-connector.git + ``` + +* Open Windows cmd and start Tableau Desktop providing the path to the connector directory and also disabling the signature check. + + ```shell + "" -DConnectPluginsPath= -DDisableVerifyConnectorPluginSignature + ``` + + Example: + + ```shell + "C:\Program Files\Tableau\Tableau \bin\tableau.exe" -DConnectPluginsPath=C:\Users\user\git\tableau-connector\src -DDisableVerifyConnectorPluginSignature + ``` + +## With Tableau Server + +* Clone the Tableau-Connector repository: + + ```shell + git clone https://github.com/exasol/tableau-connector.git + ``` + +* Package the connector with the script we provide (requires python installed): + + ```shell + /bin/bash /tableau-connector/tableau-server-GUI-tests/set_up_scripts/package_connector.sh + ``` + + Note that we run the command above in the [Git Bash](https://gitforwindows.org/) terminal. + +* Copy the `exasol_odbc.taco` file to the following path inside Tableau Server: + + ```shell + /var/opt/tableau/tableau_server/data/tabsvc/vizqlserver/Connectors/exasol_odbc.taco" + ``` + +* Disable the sign verification on the Tableau Server and apply changes: + + ```shell + tsm configuration set -k native_api.disable_verify_connector_plugin_signature -v true --force-keys + tsm pending-changes apply --ignore-prompt + ``` \ No newline at end of file