Skip to content

QDR: Public Auxfile Previewers#12190

Draft
qqmyers wants to merge 11 commits intoIQSS:developfrom
QualitativeDataRepository:QDR-PublicAuxPreviewers
Draft

QDR: Public Auxfile Previewers#12190
qqmyers wants to merge 11 commits intoIQSS:developfrom
QualitativeDataRepository:QDR-PublicAuxPreviewers

Conversation

@qqmyers
Copy link
Member

@qqmyers qqmyers commented Mar 3, 2026

What this PR does / why we need it:

This PR displays previewers that require auxiliary file(s) that are public even in cases where the user cannot download the datafile itself (i.e. it's restricted).

Dataverse allows upload of "auxiliary files" that are associated with a datafile, and it allows making auxiliary files public when the datafile itself is restricted/embargoed/beyond it's retention period. We also allow previewers and externalTools in general to 'require' auxiliary files and to display their content. However, the code cannot currently recognize that, when an auxiliary file is public, a tool requiring it can probably be used when the user does not have the ability to download the restricted datafile itself.

QDR has developed a sensitive data example with the QDAS previewers where this is relevant. QDAS codebooks can contain some entries that are more sensitive than others. The QDAS tools from Dataverse now have the ability to create 'redacted' versions of the codebook that remove such entries and to write the redacted version as a public auxiliary file. The intent is to allow people who do not have access to the full file to see only the less sensitive content.

This PR refactors the previewer code to allow this use case. It changes the overall logic of identifying which tools to display for a given datafile by making/caching the list of tools a given user is allowed to use, including tools that require a auxiliary file that exists and is public even if the user cannot access the file. (The original code made/cached a list of all the tools available for a given file and then checked the user's permission to access the file dynamically/multiple times.)

This is being created as a draft PR for a few reasons:

  • This may be a feature that should be optional
  • It may be useful to go further and specify which permissions a tool needs rather than assuming that requiring an auxiliary file means the tool can be used by anyone when the auxiliary file is public
  • It may be that the rules for explore/config/query tools should be updated for similar use cases

Which issue(s) this PR closes:

  • Closes #

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@qqmyers qqmyers added the GDCC: QDR of interest to QDR label Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GDCC: QDR of interest to QDR

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant