server_address doesn't get updated on workbook publish

Open
#337 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
api

Research direction

Start at workbooks.publish and compare the connections= path with the deprecated connection_credentials= path. Inspect tableauserverclient/models/connection_credentials.py and server/request_factory.py around line 38, then reproduce publishing with differing dev.example.com and production.example.com addresses. Done means the embedded connection's server_address is updated during publish and the workbook connects successfully.

Written by the indexing model from the issue text.

Description

bug docs

I'm working on a script that would push one workbook to multiple Tableau sites. Each site has a different database to connect to, so the embedded connection needs to be updated appropriately.

I'm trying to accomplish this by updating the embedded datasource connection information in the packaged workbook. Feel free to let me know if there's a better way to do this as I'm new to Tableau in general.

Currently, I have this:

    conn_creds = TSC.ConnectionCredentials(name=rds_user,
                                           password=rds_pass)

    # Create a connection and add the above credentials to it
    connection = TSC.ConnectionItem()
    connection.server_address = rds_host
    connection.server_port = rds_port
    connection.connection_credentials = conn_creds

    # Publish the workbook to tableau
    publish_item = server.workbooks.publish(new_workbook,
                                            workbook_file,
                                            publish_mode,
                                            connections=[connection])

This seems to work if the workbook was exported with the server_address set to the same thing as my rds_host above. So if rds_host and the server address in the workbook are both dev.example.com, it will update the credentials and publish correctly.

However, if rds_host is production.example.com and the workbook has dev.example.com, Tableau returns a failed to establish a connection to your datasource error message even though the credentials are correct.

Before I tried the above solution, I was using the (now deprecated?) connection_credentials attribute like this:

    conn_creds = TSC.ConnectionCredentials(name=rds_user,
                                           password=rds_pass)

    # Publish the workbook to tableau
    publish_item = server.workbooks.publish(new_workbook,
                                            workbook_file,
                                            publish_mode,
                                            connection_credentials=conn_creds)

This had the same effect of updating the username/password correctly, but would not update the server_address.

https://tableau.github.io/server-client-python/docs/api-ref#workbooks under workbooks.publish actually does not mention the connections= attribute at all, only connection_credentials. There was a warning message logged saying it was deprecated that lead me to use connections.

https://tableau.github.io/server-client-python/docs/api-ref#connections under ConnectionCredentials class mentions server_address and server_port attributes, but they don't seem to exist in https://github.com/tableau/server-client-python/blob/v0.7/tableauserverclient/models/connection_credentials.py and aren't used in https://github.com/tableau/server-client-python/blob/v0.7/tableauserverclient/server/request_factory.py#L38

Please let me know if I need to clarify anything or if more information is needed. I haven't looked at the code too much for this library yet, but when I get some time I planned on testing the same process with the rest api directly to verify that it isn't an issue with the server api itself.

Dominant language
Python
Stars
716
Forks
446
Avg merge
8d 8h
Merged PRs (30d)
2

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/server-client-python

All issues in tableau/server-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.