diff --git a/doc/user_guide/img/2021-07-16-13-28-43-image.png b/doc/user_guide/img/2021-07-16-13-28-43-image.png new file mode 100644 index 0000000..b242b5a Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-28-43-image.png differ diff --git a/doc/user_guide/img/2021-07-16-13-42-53-image.png b/doc/user_guide/img/2021-07-16-13-42-53-image.png new file mode 100644 index 0000000..8d32e00 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-42-53-image.png differ diff --git a/doc/user_guide/img/2021-07-16-13-42-57-image.png b/doc/user_guide/img/2021-07-16-13-42-57-image.png new file mode 100644 index 0000000..8d32e00 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-42-57-image.png differ diff --git a/doc/user_guide/img/2021-07-16-13-51-38-image.png b/doc/user_guide/img/2021-07-16-13-51-38-image.png new file mode 100644 index 0000000..23383fa Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-51-38-image.png differ diff --git a/doc/user_guide/img/2021-07-16-13-57-31-image.png b/doc/user_guide/img/2021-07-16-13-57-31-image.png new file mode 100644 index 0000000..23383fa Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-57-31-image.png differ diff --git a/doc/user_guide/img/2021-07-16-13-58-16-image.png b/doc/user_guide/img/2021-07-16-13-58-16-image.png new file mode 100644 index 0000000..0bbfc05 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-13-58-16-image.png differ diff --git a/doc/user_guide/img/2021-07-16-14-03-38-image.png b/doc/user_guide/img/2021-07-16-14-03-38-image.png new file mode 100644 index 0000000..0801fdd Binary files /dev/null and b/doc/user_guide/img/2021-07-16-14-03-38-image.png differ diff --git a/doc/user_guide/img/2021-07-16-14-06-10-image.png b/doc/user_guide/img/2021-07-16-14-06-10-image.png new file mode 100644 index 0000000..c278e52 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-14-06-10-image.png differ diff --git a/doc/user_guide/img/2021-07-16-14-07-17-image.png b/doc/user_guide/img/2021-07-16-14-07-17-image.png new file mode 100644 index 0000000..3f3bc10 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-14-07-17-image.png differ diff --git a/doc/user_guide/img/2021-07-16-14-16-08-image.png b/doc/user_guide/img/2021-07-16-14-16-08-image.png new file mode 100644 index 0000000..b66799e Binary files /dev/null and b/doc/user_guide/img/2021-07-16-14-16-08-image.png differ diff --git a/doc/user_guide/img/2021-07-16-15-28-33-image.png b/doc/user_guide/img/2021-07-16-15-28-33-image.png new file mode 100644 index 0000000..7d30153 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-15-28-33-image.png differ diff --git a/doc/user_guide/img/2021-07-16-15-30-48-image.png b/doc/user_guide/img/2021-07-16-15-30-48-image.png new file mode 100644 index 0000000..6352249 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-15-30-48-image.png differ diff --git a/doc/user_guide/img/2021-07-16-15-55-16-image.png b/doc/user_guide/img/2021-07-16-15-55-16-image.png new file mode 100644 index 0000000..6dfe735 Binary files /dev/null and b/doc/user_guide/img/2021-07-16-15-55-16-image.png differ diff --git a/doc/user_guide/user_guide_107.md b/doc/user_guide/user_guide_107.md new file mode 100644 index 0000000..0c9b922 --- /dev/null +++ b/doc/user_guide/user_guide_107.md @@ -0,0 +1,143 @@ +# Exasol Power BI Connector 1.0.7 Release - User Guide + +## New features + +- Custom Query support + +- ODBC Driver Logging + +- DSN (Data Source Name) Support + +- Limited Kerberos support + +## Installing the connector: + +### Download the .mez + +Download the 'Exasol.mez' file available on : [Releases · exasol/powerbi-exasol · GitHub](https://github.com/exasol/powerbi-exasol/releases) + +You can find it separately under the assets dropdown. + +This is the direct link: + +https://github.com/exasol/powerbi-exasol/releases/download/1.0.7/Exasol.mez + +### Copy the .mez to the following directory + +Copy the mez file to `C:\Users\\\Documents\Microsoft Power BI Desktop\Custom Connectors` Directory. + +Create the directory path if it doesn't exist. + +### Change the PowerBI Desktop settings + +Go to options in PowerBI: + +File > Options and settings > Options + +![](./img/2021-07-16-13-42-57-image.png) + +Navigate to the security tab. + +Change the data extensions setting to allow the custom connector to load. + +![](./img/2021-07-16-13-28-43-image.png) + +### Restart Power BI Desktop + +You'll need to reload PowerBI for these changes to have an effect (and the new connector version to load in). + +## Using the connector and its new features + +After installing the connector following the steps above you'll automatically use this connector when you go to Get Datasource > Get Exasol. + +The connector should be backwards compatible in that it shouldn't break your existing reports. + +As you will see the connector now looks slightly different: + +(Brief instructions on these new features follow below) + +![](./img/2021-07-16-13-51-38-image.png) + +## DSN (Data Source Name) Support + +Next to connection strings the new version of the connector now also supports Data Source Names (DSNs). + +This way you can also use preconfigured data sources. + +There are many applications of this feature ( e.g: logging, debugging, advanced authentication scenarios. ) + +### Creating a datasource + +You can create and edit datasources in the 'ODBC Data sources' app available on Windows + +![](./img/2021-07-16-13-58-16-image.png) + +Let's look at a simple example: + +Let's create a simple data source + +![](./img/2021-07-16-14-03-38-image.png) + +Let's call it "exa-test" and use the simplest connection string we can + +![](./img/2021-07-16-14-06-10-image.png) + +(You have an option to test the connection here to make sure it works. You might need to provide credentials but you can remove these after the test if you wish.) + +### Using the data source name in the connector + +Write DSN= as the connection string and press OK. + +![](./img/2021-07-16-14-16-08-image.png) + +Depending on whether you've provided credentials or not in your connection string you then pick one of the available authentication options and you should be succesfully connected. + +#### Use case: ODBC Driver Logs + +You can easily enable and disable ODBC driver logging using the data source options: + +Navigate to the 'ODBC data sources' application. + +Select your data source, click the "advanced" tab. + +![](./img/2021-07-16-15-55-16-image.png) + +You can easily turn logging on and off as well as select a desired log mode using the "Log file and "Log mode" fields. + +Another option to do this is to manually add the relevant connection string keys to the connection string or to add them to Additional Connection string parameters under 'Advanced'. + +In this case that would be: `LOGMODE=DEBUGCOMM;EXALOGFILE=C:\tmp\pbiblog.txt`; + + + +#### Use case: Advanced Kerberos scenarios + +In case the default built in Kerberos option isn't enough you can use a DSN and append KERBEROSHOSTNAME and KERBEROSSERVICENAME connection string keys and values to the connectionstring. + +#### More information + +There is also more documentation on exasol ODBC datasources configuration available here: [ODBC Driver for Windows | Exasol Documentation](https://docs.exasol.com/connect_exasol/drivers/odbc/odbc_windows.htm) + +For an overview of the other available connection string keys, see this article: + +[Using the ODBC Driver | Exasol Documentation](https://docs.exasol.com/connect_exasol/drivers/odbc/using_odbc.htm) + +# Custom Query support + +![](./img/2021-07-16-15-30-48-image.png) + +It is now possible to write a custom query to fetch results. + +You can alter this query afterwards in the Power Query editor as well. + + + +Important note: You can only use a custom query in "import" mode. You can also use DirectQuery but won't be able to use the results in any visuals. + +(You can alter the mode afterwards in the model screen in case you accidentally picked the unsupported option.) + +# Limited Kerberos support + +We also support an 'easy' kerberos authentication mode where the `KERBEROSSERVICENAME` will be `exasol/` if you choose the kerberos authentication option. + +If you need more control over this you can set the right values in the data source connection string instead (see data sources section above) and then opt for kerberos (if you use a DSN this will add no additional authentication connection string keys) or 'implicit' authentication.