diff --git a/assets/frelard_objects_extension.png b/assets/frelard_objects_extension.png new file mode 100644 index 00000000..bcc056ad Binary files /dev/null and b/assets/frelard_objects_extension.png differ diff --git a/docs/trex_getstarted.md b/docs/trex_getstarted.md index 502ca263..0dd1a863 100644 --- a/docs/trex_getstarted.md +++ b/docs/trex_getstarted.md @@ -78,27 +78,19 @@ To use the dashboard extension samples, you need to start up a web server on you ---- -### Install the dashboard extension manifest file (`.trex`) - - -Every Tableau extension has a manifest file (`.trex`) that describes the extension and identifies the location of the web application. - -1. Close Tableau, if you have it opened. -2. Copy the `.trex` files of the samples you wish to run to `~\Documents\My Tableau Repository (Beta)\Extensions` so they are available to Tableau. - The `.trex` files for the samples can be found in the folder with the samples. For example, `\extensions-api\Samples\DataSources\DataSources.trex`. - - - --- ### Start Tableau and add an extension to the dashboard 1. Start Tableau and open a workbook that has a dashboard, or open a workbook and create a new dashboard. -2. In the dashboard, under **Extensions**, select one of the sample extensions and drag it on to the dashboard. For example, drag **DataSources Sample** to the dashboard. - ![]({{site.baseurl}}/assets/frelard_extensions1.png) - +2. In the dashboard, under **Objects**, select **Extension** and drag it on to the dashboard. + ![]({{site.baseurl}}/assets/frelard_objects_extension.png) + +3. In the **Select an Extension** dialog box, click **Choose an Extension**. + Every Tableau extension has a manifest file (`.trex`) that describes the extension and identifies the location of the web application. +4. Browse to the directory where the samples are located. For example, if you downloaded or cloned the GitHub repository, go to `\extensions-api\Samples`. +5. Open the `DataSources.trex` file. The sample extension (web application) appears in the dashboard frame. The DataSources sample finds and displays the data source for each worksheet in the dashboard. -3. In the DataSources extension, click the **Info** (**i**) button. This action opens a dialog box that displays more details about the selected data source. +6. In the DataSources extension, click the **Info** (**i**) button. This action opens a dialog box that displays more details about the selected data source. ![]({{site.baseurl}}/assets/data_source.gif) diff --git a/docs/trex_release-notes.md b/docs/trex_release-notes.md index eb89e0cd..d4fc3db7 100644 --- a/docs/trex_release-notes.md +++ b/docs/trex_release-notes.md @@ -10,6 +10,35 @@ layout: docs --- +### Developer Preview (0.8.0) +*December 21, 2017* + +- Update of the Tableau Extensions API. +- Tableau Extensions API library: `tableau-extensions-0.8.0.js` +- Tableau Desktop 10.5 RC, Tableau Server 10.5 (from [Extensions API Developer Preview](https://prerelease.tableau.com){:target="_blank"}) + + +**New desktop authoring experience** + +You no longer need to place the `.trex` file for the extension in a predetermined folder, you now do the following: + + 1. In the dashboard, under **Objects** on the left, select **Extension** and drag it to the dashboard sheet on the right. + The **Select an Extension** dialog box appears. + 2. The first time you open the dialog box to add an extension, you will see a link to **Choose an Extension**. Click the link and browse to the directory where you have the `.trex` file. +Subsequently, when you drag the **Extension** on the dashboard, the dialog box shows you the most recently used list, choose from the list, or click **Browse** to select another extension. + +**New UI namespace** + +- You can now launch a new modal dialog using the function: `tableau.extensions.ui.displayDialogAsync(someUrl)`. +- The URL you want to load (`someUrl`) will be an extension itself. +- Note that the UI namespace is work is still in progress. *Stay tuned for more.* + +**HTTPS and security** + +For information about the HTTPS requirements for extensions, see [Security and Tableau Extensions]({{site.baseurl}}/docs/trex_security.html) + + + ### Developer Preview (0.7.0) *November 29, 2017* diff --git a/docs/trex_security.md b/docs/trex_security.md index 2747b5c6..7cf864a0 100644 --- a/docs/trex_security.md +++ b/docs/trex_security.md @@ -38,10 +38,10 @@ If you plan to make your extension available to others, using HTTPS The requirements are pretty straight-forward. If you are distributing your extension so that others can use it, the extension must be hosted on a web server that is configured to support the HTTPS protocol. - The server that hosts your extension must have a certificate from a Certificate Authority (CA). There are many free and low cost options. Note that self-signed or test-signed certificates are not sufficient. The certificate is sometimes called an SSL certificate, as HTTPS was formerly implemented by the Secure Sockets Layer (SSL). -- In the `.trex` file for your extension, the `url` you use for the source location must start with `https://` . If the HTTPS protocol is not specified, the extension fails registration and does not appear in list of available extensions in Tableau. -The exception to this requirement is for `localhost`. If you are developing your extension, you can host it on your computer using HTTP (for example, `http://localhost`). You can also use `localhost` on Tableau Server. +- In the `.trex` file for your extension, the `url` you use for the source location must start with `https://`. If the HTTPS protocol is not specified, the extension fails registration and does not appear in list of available extensions in Tableau. +The exception to this requirement is for `localhost`. If you are developing your extension, you can host it on your computer using HTTP (for example, `http://localhost`). You can also use `http://localhost` if you publish the workbook to Tableau Server. In this case, the extension must be running on the same computer as the browser you are using to access the server. - Mixed content is not allowed. If your web application uses other libraries or resources, those assets should also use `https`, or use site-relative links. -- Redirects are permitted, but if they redirect to HTTP pages, those pages cannot interact with the Extensions API. +- Redirects are permitted, but if they redirect to any other origin, other than the URL of the extension, those pages cannot interact with the Extensions API. For example, if the URL of your extension is `https://example.com` and you redirect to `https://myexample.com`, the page you were redirecting to (`https://myexample.com`) cannot interact with the Extensions API. - To run on Tableau Server, your extension must be added to the safe list for the site. Site administrators can add or remove extensions, and can configure how an extension requests permissions for access to data. ----