From 4f5d0814f3fa590a93be1b114f8491160930587b Mon Sep 17 00:00:00 2001 From: ShashiSubramnya Date: Wed, 5 Feb 2025 16:59:09 +0530 Subject: [PATCH] SCAL-240710, loglevel error issue and known issue updates --- modules/ROOT/pages/open-issues.adoc | 24 ++++++++++-- modules/ROOT/pages/security-settings.adoc | 14 ++++--- modules/ROOT/pages/tml.adoc | 47 +++++++++++++++++++++++ 3 files changed, 76 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/open-issues.adoc b/modules/ROOT/pages/open-issues.adoc index c1c5630da..8fb77414a 100644 --- a/modules/ROOT/pages/open-issues.adoc +++ b/modules/ROOT/pages/open-issues.adoc @@ -8,6 +8,24 @@ This page lists the known issues that you might run into while embedding ThoughtSpot in your app, or when using the embedded interface or making REST API calls. + +== Version 10.5.0.cl + +[cols="2,6"] +[options='header'] +|===== +|Issue Description| Symptoms, conditions, and workaround +|The `LogLevel: Error` property does not suppress information alerts, debug alerts and warnings from the ThoughtSpot application.| +**Symptom**: + +Although the `LogLevel` attribute in the Visual Embed SDK is set to `Error` to show only the error logs in the browser console, other ThoughtSpot application logs such as information alerts, warnings, and debug messages are also displayed. + +**Conditions** + +This issue is observed on ThoughtSpot instances running 10.5.0.cl and earlier versions. + +**Workaround** + +None. +|===== + == Version 9.12.5.cl [cols="2,6"] @@ -37,7 +55,9 @@ On exporting and reimporting TML in YAML format in the REST API v2 Playground, t `Invalid YAML/JSON syntax in file.` **Conditions**: + This issue occurs because when reimporting TML invalid characters are added to the TML YAML content in the Playground resulting in an invalid syntax error. -**Workaround**: +**Workaround**: + +See xref:tml.adoc#_yaml_reimport_in_rest_api_playground[YAML reimport in the REST API v2 Playground]. + We recommend the following steps to work around this issue: + . On the REST API v2 Playground, +++export the TML in YAML format+++. @@ -82,12 +102,10 @@ The request body JSON appears as shown in this example: If you still get an error, try out the steps shown in this video: + video::./images/yaml-tml-export.mp4[width=100%,options="autoplay,loop"] - || |===== - == Version 9.10.0.cl [cols="2,6"] diff --git a/modules/ROOT/pages/security-settings.adoc b/modules/ROOT/pages/security-settings.adoc index ffbe26279..fa01d4dab 100644 --- a/modules/ROOT/pages/security-settings.adoc +++ b/modules/ROOT/pages/security-settings.adoc @@ -105,12 +105,14 @@ To add domain names to the CORS allowlist, follow these steps: [IMPORTANT] ==== [#port-protocol] -Note the following points if using port or protocol in the domain name string: -* The UI allows you to add a domain URL with or without the protocol (`http/https`) in the CSP allowlist. To avoid long URLs in the CSP header, we recommend that you don't include the protocol in the domain name string. However, for non-HTTPS domains, such as your local testing environment, do include `http` in the domain name string. -* Although you can add a domain URL with the protocol (`http/https`) to the CORS allowlist, ThoughtSpot ignores the protocol in the domain names of CORS hosts. Therefore, you can exclude the protocol in the domain name strings. -* If your domain URL has a non-standard port such as 8080, specify the port number in the domain name string. -* You can add multiple domain names to the CORS and CSP Visual Embed hosts list on the **Develop** > **Security Settings** page. Ensure that the CORS and CSP host allowlist does not exceed 4096 characters. +* You can add multiple domains to the CORS and CSP Visual Embed allowlists on the **Develop** **Customizations** > **Security Settings** page. Ensure that the CORS and CSP allowlists do not exceed 4096 characters. +* *Protocol in the domain URL*: +** CSP hosts — The UI allows adding a domain URL with or without the protocol (`http/https`). However, to avoid long URLs in the CSP header, you can exclude the protocol in the domain URL strings. +** CORS hosts — The UI allows adding a domain URL with the protocol (`http/https`). However, ThoughtSpot ignores the protocol in the CORS host domain. Therefore, you can exclude the protocol in the domain URL strings. +** For localhost and non-HTTPS URLs — For non-HTTPs domains or localhost such as `localhost:3000`, if you add the domain without the protocol, the `https` protocol will be used by default. Due to this, the localhost domain with `http` (`\http://localhost:3000`) might result in a CSP or CORS error. Therefore, include the `http` protocol in the domain name strings for non-HTTPS domains and localhost. +* **Port**: If your domain URL has a non-standard port such as 8080, specify the port number in the domain name string. + ==== The following table shows the valid domain name strings for the CORS and CSP allowlists. @@ -127,7 +129,6 @@ CSP img-src a|Domain URL strings without protocol - * `thoughtspot.com` * `www.thoughtspot.com` + @@ -137,6 +138,7 @@ a|Domain URL strings for localhost * `localhost` * `localhost:3000` +* `\http://localhost:8080` * `\http://localhost:3000` |[tag greenBackground tick]#✓# Supported|[tag greenBackground tick]#✓# Supported 2*|[tag greenBackground tick]#✓# Supported diff --git a/modules/ROOT/pages/tml.adoc b/modules/ROOT/pages/tml.adoc index bb7fcfed8..7d296c501 100644 --- a/modules/ROOT/pages/tml.adoc +++ b/modules/ROOT/pages/tml.adoc @@ -369,6 +369,53 @@ ThoughtSpot offers a lot of flexibility within its set of xref:intro-thoughtspot == Limitations of working with TML files There are certain limitations to the changes you can apply by editing a ThoughtSpot object through TML. Visit link:https://docs.thoughtspot.com/cloud/latest/tml#_limitations_of_working_with_tml_files[Limitations of working with TML files, window=_blank] for detailed information. +=== YAML reimport in REST API v2 Playground + +In the REST API v2 Playground, if the TML YAML contains invalid characters, the import API operation fails with an invalid syntax error. To work around this issue, use the following steps: + +. On the REST API v2 Playground, +++export the TML in YAML format+++. +. Copy the edoc output from the API response in the code panel. +. Paste it in a text editor such as Sublime. + +For example, `"guid: a162289a-c1ab-427e-9985-8fb5f7c7e539\nliveboard:\n name: Liveboard 1\n"` ++ +. Check if the output is enclosed in quotation marks ("). Remove the quotation marks and update the TML text as shown here: + +`guid: a162289a-c1ab-427e-9985-8fb5f7c7e539\nliveboard:\n name: Liveboard 1\n` + +. On the+++ Import Metadata TML API page+++, go to **body** > **metadata_tmls** parameter. + +. Add / remove objects in that list based on how many TML objects you want to import. +. Click **VIEW JSON** to view the object properties in JSON format. + +The request body JSON appears as shown in this example: ++ +[source,JSON] +---- +{ + "metadata_tmls": [ + "metadata_tmls3" + ], + "import_policy": "PARTIAL", + "create_new": false, + "all_orgs_context": false +} +---- +. Replace `metadata_tmls3` with the text copied from step 4. Ensure that the text you copy doesn't include additional characters and quotation marks. ++ +[source,JSON] +---- +{ + "metadata_tmls": [ + "guid: a162289a-c1ab-427e-9985-8fb5f7c7e539\nliveboard:\n name: Liveboard 1\n" + ], + "import_policy": "PARTIAL", + "create_new": false, + "all_orgs_context": false +} +---- +. Execute the API call by clicking **Try it Out**. + ++ +If you still get an error, try out the steps shown in this video: ++ +video::./images/yaml-tml-export.mp4[width=100%,options="autoplay,loop"] + == Deployment and version control of TML objects For information about version control and TML deployment, see the following pages: