Replace Extract in Packaged Workbook

Open
#102 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
tooling

Research direction

Start with tableaudocumentapi.Workbook and its save_as method, then compare the existing .twb XML reference replacement with the packaging behavior of .twbx files. Investigate how the connection's .tde extract is represented in a packaged workbook. Done means replacing the extract while preserving the table definition and producing a self-contained new_workbook.twbx.

Written by the indexing model from the issue text.

Description

enhancement

I'm trying to figure out how to replace an extract in a packaged workbook with a different extract that has the same table definition. I can use the Tableau SDK to create a new .tde, but it looks like there aren't python methods to replace an extract in a packaged workbook.

I'm imagining this would look something like this:

from tableaudocumentapi import Workbook

sourceWB = Workbook('workbook.twbx')
sourceWB.datasources[0].connections[0].extract = "MY-NEW-EXTRACT.tde"
#OR sourceWB.datasources[0].connections[0].extract.package('new-extract.tde')

sourceWB.save_as('new_workbook.twbx')

I can replace an extract in a .twb file by hacking the xml and changing references, but the "save_as" method doesn't actually package the workbook so that the connection is no longer dependent on a .tde file.

Dominant language
Python
Stars
363
Forks
183
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tableau/document-api-python

All issues in tableau/document-api-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.