Supporting live connections to cloud files (Box)

Open
#158 0 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
Needs clarification
Activity status
Stale
Tech stack
python
Domain
tooling

Research direction

Start by reviewing the published-workbook XML snippet in this issue and the document-api-python code paths for updating connections. Compare the Box live-connection structure with the server-client-python issue linked in the report. Done means establishing and documenting the minimum fields needed to update and republish this connection.

Written by the indexing model from the issue text.

Description

connectorRequest

I have an issue with updating the connections to a workbook once I added a live connection to an Excel file via Box. I was using the Rest API v2.8 using server-client-python package have an open issue in that repo as well.

I am sharing what the xml snippet looks like in my published workbook for this connection to see if there's any modification that can be suggested to update the connection / traverse the ETree. What would be the bare minimum fields that need to be repopulated every time to publish to server, i.e. what is the Desktop client doing to the xml when we click publish with a live connection like this?

      <connection class="federated">
        <named-connections>
          <named-connection caption="Reporting_Commentary" name="cloudfile:box-excel-direct.1bk2zjd1uefpc71dfvxop1xj4y0b">
            <connection class="cloudfile:box-excel-direct" cleaning="no" cloudFileExtension="xlsx" cloudFileId="318391143483" cloudFileMetadata_-_folder="53478632394" cloudFileName="Reporting_Commentary.xlsx" cloudFileProvider="box" cloudFileRequestURL="https://api.box.com/2.0/files/318391143483/content" compat="no" dataRefreshTime="" filename="Reporting_Commentary.xlsx" interpretationMode="0" server="" server-oauth="server-custom" userLanguage="en" username="uname@example.com" validate="no" workgroup-auth-mode="prompt"/>
          </named-connection>
        </named-connections>
        <relation connection="cloudfile:box-excel-direct.1bk2zjd1uefpc71dfvxop1xj4y0b" name="Content" table="[Content$]" type="table">
          <columns gridOrigin="A1:D91:no:A1:D91:0" header="yes" outcome="6">
            <column datatype="date" name="Fiscal week start" ordinal="0"/>
            <column datatype="string" name="Aggregation" ordinal="1"/>
            <column datatype="string" name="Calculation Type" ordinal="2"/>
            <column datatype="string" name="Commentary" ordinal="3"/>
          </columns>
        </relation>
        <metadata-records>
        ...
        </metadata-records>
      </connection>
Dominant language
Python
Stars
363
Forks
183
PR merge metrics
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.