Skip to content

Commit 3da0167

Browse files
edits
1 parent 42d0799 commit 3da0167

2 files changed

Lines changed: 13 additions & 20 deletions

File tree

modules/ROOT/pages/embed-spotter.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ To embed Spotter, you need the following access and setup:
1818

1919
[NOTE]
2020
====
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.
2423
====
2524

2625

modules/ROOT/pages/filters_overview.adoc

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ The behavior of each filter type and the mechanism for setting filters can diffe
1313
There are different types of filters, which can be applied in the following order:
1414

1515
1. xref:rls-rules.adoc[**Row-level security (RLS) Rules**] +
16-
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. +
1717
RLS rules secure data and cannot be altered by the logged-in user. +
1818
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)].
1919

2020
2. **Data Model filters** +
2121
Models can have parameters, formulas, and filters. +
2222
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.
2424

2525
3. xref:runtime-filters.adoc[Runtime filters] and xref:runtime-parameters.adoc[Runtime Parameters] +
2626
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.
3232

3333
4. link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters[Liveboard filters, window=_blank] +
3434
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`.
3636

3737
5. link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters-cross[Liveboard cross filters, window=_blank] +
38-
Cross-filters are ad-hoc filters based on user selection. These filters are used for brushing and linking Liveboard visualizations. +
39-
Cross-filters are supported only on attribute columns.
38+
Cross filters are ad-hoc filters based on user selection. These filters are used for brushing and linking Liveboard visualizations. +
39+
Cross filters are supported only on attribute columns.
4040

4141
6. link:https://docs.thoughtspot.com/cloud/latest/filters[Search query filters, window=_blank] +
4242
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. +
4444
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.
4545

4646
== Filter attributes
4747
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.
4848
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.
4949

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.
5151

5252
A data filter object in ThoughtSpot typically includes the following attributes:
5353

@@ -200,7 +200,7 @@ LiveboardEmbed.trigger(HostEvent.OpenFilter,
200200
----
201201

202202
=== UpdateFilters event
203-
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:
204204

205205
[source,JavaScript]
206206
----
@@ -214,22 +214,17 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, {
214214
});
215215
----
216216

217-
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-
221217
=== GetFilters and GetParameters events
222218
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:
223219

224220
[source,JavaScript]
225221
----
226222
const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
227-
console.log('data', data);
223+
console.log('data', data);
228224
229225
liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
230-
console.log('parameters', parameter);
226+
console.log('parameters', parameter);
231227
});
232-
233228
----
234229

235230
Note that `HostEvent.GetFilters` and `HostEvent.GetParameters` return a promise directly rather than taking a callback function as their second argument.
@@ -465,8 +460,7 @@ liveboardEmbed.trigger(HostEvent.UpdateFilters, {
465460
});
466461
----
467462

468-
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.
470464

471465

472466
////

0 commit comments

Comments
 (0)