Skip to content

enable-liveboardv2.adoc

Latest commit

 

History

History
170 lines (127 loc) · 8.66 KB

enable-liveboardv2.adoc

File metadata and controls

170 lines (127 loc) · 8.66 KB

New Liveboard experience

Table of Contents

The new Liveboard experience in ThoughtSpot includes several new features and user-experience improvements. Users with developer or administrator privileges can enable the new Liveboard experience at the cluster level and set it as the default experience for all users. Individual application users can also set the Liveboard experience preference on their profile settings page.

Note

The new Liveboard experience is Generally Available (GA) on embedded instances starting from 9.0.0.cl.

Enable new Liveboard experience for all users

You can enable the new Liveboard experience using one of the following options:

  • Go to Admin > Search & SpotIQ and edit the Liveboard experience preference.

  • Set the liveboardV2 attribute in the SDK to true.

    If the liveboardv2 attribute is not set in the SDK, ThoughtSpot will use the Liveboard experience setting applied at the cluster level. If the new Liveboard experience is enabled in the SDK, it will take precedence over the setting applied at the cluster level in the Admin tab.

    The following examples show how to enable the new Liveboard experience on an embedded ThoughtSpot application:

    const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), {
    frameParams: {
        width: '100%',
        height: '100%',
    },
    liveboardV2: true,
});
    const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
    frameParams: {
        width: '100%',
        height: '100%',
    },
    liveboardV2: true,
});

Liveboard experience

The new Liveboard experience introduces notable changes, new menu options, and enhancements.

Liveboard editing

To edit a Liveboard, users must switch to the edit mode by clicking the Edit button on the Liveboard page. For example, to delete a visualization on a Liveboard, the user must click Edit, and then navigate to the Delete option on a visualization.

Filter application

To apply filters, users must switch to the Liveboard edit mode. Only users with edit access to the Liveboard can apply filters.
The new experience also introduces the following enhancements to Liveboard filters:

Action enhancements

  • The Add filters action is placed on the primary menu bar and can be viewed only when a Liveboard is in edit mode.

  • The Undo, Redo, and Reset buttons appear on visualizations when a user drills down to view specific data points on a visualization.

  • The Liveboard Info action label in the More the more options menu is renamed to Show Liveboard details.

  • The Schedule action is placed in the More the more options menu menu.

  • The following actions are deprecated:

    • The Copy embed link and Copy link menu actions in the More the more options menu menu of a Liveboard

    • The edit title icon on visualization tiles

    • The Share button on visualizations

The following figure illustrates the menu actions available on a Liveboard page:

Liveboard experience comparison

Customize embedded Liveboards

Customize actions

You can use the Action enumeration members available in the SDK to customize an embedded Liveboard.

For example, to disable the Delete action for a visualization object on the Liveboard, you can use the Action.Remove enum.

For more information, see Show or hide UI actions and Action Reference.

Trigger events

The embedded Liveboards support all host and embedded application events in the SDK irrespective of the Liveboard experience setting. For example, you can register and trigger events such as VizPointClick for visualizations on a Liveboard.

For information about events, see Events and app integration and Events Reference.

Customize Liveboard tabs

The new Liveboard experience allows you to organize your visualizations into tabs. Liveboard tabs allow you to logically group visualization into specific categories and allow users to access them easily.

To create, edit, or move visualizations to a tab, you require edit access to a Liveboard.

  • To add a tab, click Edit and then click Add tab on the Liveboard page.

    Note that each new tab object is assigned a unique GUID.

  • To add a visualization to a tab on a Liveboard, click Move to tab from the More the more options menu menu.

    You can also pin a visualization to a Liveboard tab using the Pin action on the Answer page.

Set a tab as an active tab

By default, the first tab created on a Liveboard is set as the home tab. You can set any tab as an active tab using the activeTabId property in the Visual Embed SDK as shown in the example here:

const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), {
    frameParams: {
        width: '100%',
        height: '100%',
    },
    liveboardV2: true,
    liveboardId: "d7a5a08e-a1f7-4850-aeb7-0764692855b8",
    activeTabId: "05406350-44ce-488e-abc5-5e8cdd65cf3c",
});
Note

The activeTabId property is available only in the LiveboardEmbed package and not supported in the full application embed mode.

Customize visualization tiles

If the custom tile size feature is enabled on your instance, and you have edit access to the Liveboard, you can resize the visualization tiles as described in the following steps:

  1. Navigate to the Liveboard.

  2. On the Liveboard page, click the Edit button in the top menu bar.

  3. Select a visualization tile, click the size-changing icon in the bottom right corner, and drag the visualization tile to the desired size.

  4. Repeat the steps to resize other visualizations on the Liveboard.

Add Note tiles Early Access

Starting from 9.2.0.cl, you can add a Note tile with custom text, images, and links on an embedded Liveboard. The Note tiles feature is turned off by default and can be enabled by your application administrator.

If this feature is enabled on your instance, note the following limitations:

  • Only users with edit access to a Liveboard can add a Note tile.

  • In 9.2.0.cl, only users with administration, developer, or Can upload data privilege can upload an image to the note tile.

  • If you are adding external links and images from a URL, make sure the relevant CSP settings are configured. For more information, see Security settings.

For more information, see Liveboard Note tiles.

Known issues and limitations

  • The current version of the SDK doesn’t include an action enumeration for the Rename action in the More menu the more options menu of an embedded Liveboard and visualization. If you must disable or hide the Rename action, use 'renameModalTitleDescription' in the disabledActions and hiddenActions array.

  • If the worksheet used for generating visualizations contains Parameters, Liveboard users can apply Parameters to Liveboard. On embedded instances running 9.2.0.cl or lower release versions, the Add Parameter action on Liveboard cannot be disabled or hidden using the Action.AddParameter enumeration.

  • To show, hide, or disable the Download PDF menu action on a Liveboard, use the Action.DownloadAsPdf instead of Action.Download. When used in the visibleActions array, it doesn’t show the sub-menu options for Download on a Liveboard visualization.

  • To trigger the Download action on a Liveboard or its visualizations, use the following host events instead of HostEvent.Download.

    • HostEvent.DownloadAsPng

    • HostEvent.DownloadAsXlsx

    • HostEvent.DownloadAsCsv

    • HostEvent.DownloadAsPdf

Additional resources