[TYPE 3] Flow Run Notes

Open
#1,457 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
api

Research direction

Start at the flows/runs endpoint and inspect how flowRun XML is represented, including its backgroundJobId reference. Determine how available background-job notes should be exposed to non-admin creators without requiring a separate job query. Done means flow-run responses provide the requested notes when available and preserve the existing permissions context.

Written by the indexing model from the issue text.

Description

enhancement needs investigation Server-Side Enhancement ui-exists

Summary

Provide notes from the relevant background job in the flowRun XML.

Request Type

Type 3: new functionality
Requests for totally new functionality will generally be passed to the relevant dev team, but we probably can't give any useful estimate of how or when it might be implemented. If it is a feature that is 'about' the API or programmable access, here might be the best place to suggest it, but generally feature requests will be more visible in the Tableau Community Ideas forum and should go there instead.

Description

A clear and concise description of what the feature request is. If you think that the value of this feature might not be obvious, include information like how often it is needed, amount of work saved, etc. If your feature request is related to a file or server in a specific state, describe the starting state when the feature can be used, and the end state after using it. If it involves modifying files, an example file may be helpful.

If a non-admin creator is trying to get details about a flow run failure, it is currently not possible with the permissions context. flowRun XML contains a reference to a backgroundJobId, but if the creator is a non-admin, they are not able to query jobs, even by id, on a given site. If notes from the background job are available through the "flows/runs" endpoint, then a creator will not have to engage with a site/server admin to retrieve the details on the failure.

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.