embedding-api-v3-guide icon indicating copy to clipboard operation
embedding-api-v3-guide copied to clipboard

Retrieve the list of Actions of a Viz

Open florent-guinard opened this issue 2 years ago • 5 comments

We'd like to be able to retrieve the list of Actions (Worksheet/Dashboard > Actions in Tableau) for a Worksheet/Dashboard in an embedded Workbook: image

We're looking for as much information as possible on those actions, like:

  • Type
  • Name
  • Run action on
  • Target
  • "Clearing the selection will"
  • Fields
  • URL for URL Actions

Thanks !

florent-guinard avatar Mar 01 '22 16:03 florent-guinard

Hi @florent-guinard - Thank you for opening this issue. Do you mind sharing more about your use case please?

illonage avatar Mar 01 '22 20:03 illonage

@illonage Sure ! We embed Vizs using the Embedding API to make sure that they are fully functional: every available action (like updating a filter value) produces the expected result (data is properly filtered).

Actions are part of the features available to end-users when they open those Vizs in Tableau: our goal is to programmatically trigger those actions and then measure their outcomes to compare them with the action definitions, answering questions such as "was this parameter value properly updated by triggering this action ?".

We can already programmatically trigger "Select" actions with the "Select Mark" function but:

  • We do not have any information about the available Actions in a given Viz (which actions are available, how they should be triggered, what are their expected outcomes)
  • We can't trigger "Hover/Menu" Actions

The first point is the subject of this enhancement, the second one needs a dedicated issue :-)

I hope it makes sense, please come back to me if it doesn't!

florent-guinard avatar Mar 02 '22 14:03 florent-guinard

Wow this is a great request, would love to get access to this info!

Mrkbingham avatar Mar 02 '22 14:03 Mrkbingham

Thanks @florent-guinard ! @Mrkbingham do you have the same use cases?

illonage avatar Mar 04 '22 16:03 illonage

@illonage yep! Somewhat similar, I’d like to be able to read all of the settings that someone has set up inside Tableau so my app can detect the set behavior. The major config that would be helpful are: Target, Fields and URL (also the href target, e.g. open in new tab)

The URL would help ensure that we’re opening a URL that may already be embedded in our app, if not we send the users over to Tableau Server.

The fields would be helpful for tracking user behavior - we currently track filter events in the applyFilter callback, and would like to continue that.

Lastly the name of the action: we log errors for unexpected behavior, and if we could say “Action [Title] failed” it would help immensely for users when troubleshooting.

Mrkbingham avatar Mar 15 '22 14:03 Mrkbingham