Skip to main content Skip to complementary content

Including variable states in bookmarks and reports

You can configure variables to have their states included in bookmarks and reports.

By default, variable states are not included when users create bookmarks or reports. App creators and app users have different options for including variable states in bookmarks and reports.

You can configure your app's variables to have their current state included when users create a bookmark or report. By selecting Include in bookmarks, app creators can have variable states automatically included in bookmarks and reports.

You can also choose to include variable states in bookmarks and reports. When creating bookmarks, you can use Save all variables states. When creating subscriptions to reports, you can select the option Use variable state to include variable states in the report. For more information, see:

Advantages of setting Include in bookmarks on variables

There are two advantages to setting Include in bookmarks on variables over the other options. You can choose which variables to have their states included in bookmarks and reports on an individual basis. This gives you more control over what variable states are included. Additionally, Include in bookmarks allows for variables created to the load script to have their current state included. Script variable states are not included when you use Save all variables states in a bookmark or Use variable state in a subscription.

Interactions between the variable setting and bookmark and subscription settings

If Include in bookmarks is selected, it will overrule the option selected for Save all variables states in bookmarks and Use variable state in subscriptions.

The table below summarizes the behavior of bookmarks and reports for including variable states when Include in bookmarks and Save all variables states/Use variable state are used.

Interaction summary
Include in bookmarks Save all variables states /Use variable state Result
Yes Yes Variable states of all variables included.
Yes No Variable states of variables with Include in bookmarks selected included.
No Yes Variable states of all variables included.
No No Variable states not included.

Saving variable states in bookmarks

  1. When editing a sheet, click Variables in the edit bar on the sheet to open the variables dialog.

    The variables dialog opens.

  2. In the row of the variable you want to delete, click and select Edit.

  3. Select Include in bookmarks.

  4. Click Save.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!