You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/embed-spotter.adoc
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,8 @@ To embed Spotter, you need the following access and setup:
18
18
19
19
[NOTE]
20
20
====
21
-
For Spotter embedding that uses cookieless authentication, use the Visual Embed SDK v1.45.0 or later with ThoughtSpot Cloud 26.2.0.cl or a later version. To enable proactive token refresh, set the `refreshAuthTokenOnNearExpiry` parameter to `true`.
22
-
23
-
Spotter workflows can run longer, so ensure the authentication token expiry is set to at least 10 minutes to avoid authorization errors.
21
+
For Spotter embedding that uses cookieless authentication, use the Visual Embed SDK v1.45.0 or later with ThoughtSpot Cloud 26.2.0.cl or a later version. To enable proactive token refresh, set the `refreshAuthTokenOnNearExpiry` parameter to `true`. +
22
+
Spotter workflows can run longer, so set the authentication token expiry to at least 10 minutes to avoid authorization errors.
Rules are defined at the table level and applied at the query generation layer to all objects derived from that table. Rules can be defined based on the logged-in user, their group memberships, or custom variables. +
16
+
Rules are defined at the table level and applied during query generation to all objects derived from that table. Rules can be defined based on the logged-in user, their group memberships, or custom variables. +
17
17
RLS rules secure data and cannot be altered by the logged-in user. +
18
18
RLS rules can also be used, along with custom variables and the JSON Web Token (JWT) generated for the user, to implement xref:abac_rls-variables.adoc[Attribute-Based Access Control (ABAC)].
19
19
20
20
2. **Data Model filters** +
21
21
Models can have parameters, formulas, and filters. +
22
22
Embedding application users cannot affect the formulas or filters, which are always applied, but Parameters used in a formula can be set by other methods. +
23
-
If the user can edit the Parameter, use the runtime parameters layer to programmatically set the parameter value.
23
+
If the user can edit the parameter, use the runtime parameters layer to programmatically set its value.
24
24
25
25
3. xref:runtime-filters.adoc[Runtime filters] and xref:runtime-parameters.adoc[Runtime Parameters] +
26
26
You can define xref:runtime-filters.adoc[runtime filters] and xref:runtime-parameters.adoc[runtime parameters] within the browser for a given object at load time. Filters and parameters can be set using the Visual Embed SDK, REST API, or URL query parameters and updated via host events in the Visual Embed SDK.
@@ -32,22 +32,22 @@ Runtime filters do not display as UI filter components.
Liveboard filters apply to all visualizations on the Liveboard and are visible as UI components at the top of a Liveboard page. When a filter is clicked, a modal with filter options appropriate for the data type is displayed. +
35
-
Liveboard users can add or modify filters as required. If you are embedding a Liveboard that includes preset filters, you can programmatically update, reset, or remove filters using the `HostEvent.UpdateFilters`.
35
+
Liveboard users can add or modify filters as needed. If you are embedding a Liveboard that includes preset filters, you can programmatically update, reset, or remove filters using the `HostEvent.UpdateFilters`.
Set via the search query string in Answers and visualizations, not visible as UI filter components on a Liveboard, but can be viewed in **Explore** or *Edit* modes. +
43
-
The lowest layer of filters is defined as part of the search query for a given Answer or visualization on a Liveboard. +
43
+
The lowest layer of filters is defined in the search query for a given Answer or visualization on a Liveboard. +
44
44
The link:https://docs.thoughtspot.com/cloud/latest/filters[filter terms, window=_blank] are saved as part of the `search_query` of the object, visible in TML.
45
45
46
46
== Filter attributes
47
47
When specifying a column for filtering, you must use the exact column name as defined in the model. Filters can be applied to string, number, boolean, Date, Datetime, and time data types.
48
48
For the `DATE` and `DATE_TIME` data types, some filter types may require the date and time values to be specified in the Epoch time format.
49
49
50
-
All operations include a form of `WHERE` clause being applied to the resulting queries generated by ThoughtSpot, or no query being issued if the resulting logic is always false.
50
+
All operations result in a `WHERE` clause being applied to the queries generated by ThoughtSpot, or no query being issued if the logic is always false.
51
51
52
52
A data filter object in ThoughtSpot typically includes the following attributes:
The link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updatefilters[HostEvent.UpdateFilters] directly updates the values of the target Liveboard filter:
203
+
The link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_updatefilters[HostEvent.UpdateFilters] directly updates the values of the target of an existing filter that's currently applied on a Liveboard:
The Liveboard filter must already exist on the Liveboard for `HostEvent.UpdateFilters` to work.
218
-
219
-
For more information and examples, see xref:embed-pinboard.adoc#_filters[Liveboard filters].
220
-
221
217
=== GetFilters and GetParameters events
222
218
If you want to build your own filter UI within the embedding app, you can find out details of the Liveboard and runtime filters that are defined using the link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_getfilters[HostEvent.GetFilters]. There is an equivalent link:https://developers.thoughtspot.com/docs/Enumeration_HostEvent#_getparameters[HostEvent.GetParameters] to get the currently set Parameter values:
223
219
224
220
[source,JavaScript]
225
221
----
226
222
const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
Note that `HostEvent.GetFilters` and `HostEvent.GetParameters` return a promise directly rather than taking a callback function as their second argument.
Setting empty values via `HostEvent.UpdateFilters` removes only the values applied to the filter and it doesn't remove or hide the filter chip from the Liveboard.
469
-
463
+
Setting empty values via `HostEvent.UpdateFilters` removes only the filter values; it does not remove or hide the filter chips from the Liveboard.
0 commit comments