Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional properties to CKAN metadata to define Flask DB Relationship #4856

Closed
5 tasks
btylerburton opened this issue Aug 21, 2024 · 3 comments
Closed
5 tasks
Labels
H2.0/Harvest-DB Postgres and related DB tickets H2.0/Harvest-Runner Harvest Source Processing for Harvesting 2.0

Comments

@btylerburton
Copy link
Contributor

btylerburton commented Aug 21, 2024

User Story

In order to allow for the correlation between a record in CKAN and a record in the flask db interface, datagovteam wants to add new properties to the CKAN metadata:

  • record_id
    • the id of the record in the flask db
    • needed to display a link to the original metadata in the CKAN UI interface
  • harvest_source_id
    • the id of the flask db harvest_source that this record corresponds to
    • needed to clear entries out of CKAN DB and Solr without clearing an organization's other datasets
  • harvset_source_name
    • the human readable name of the flask db harvest_source
    • needed to display name of harvest source in CKAN UI

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

  • GIVEN I am harvesting a new harvest source
    WHEN I am pushing a new dataset to CKAN via the REST API
    THEN I want that to include the origin_record_id, origin_harvest_source_id, and origin_harvest_source_name as additional metadata properties

  • GIVEN I have harvested a new dataset
    WHEN I look at the metadata in CKAN I will see additional properties of origin_record_id, origin_harvest_source_id, origin_harvest_source_name that are not part of the original dataset's metadata.

Background

[Any helpful contextual notes or links to artifacts/evidence, if needed]

Security Considerations (required)

[Any security concerns that might be implicated in the change. "None" is OK, just be explicit here!]

Sketch

  • Add origin_record_id, origin_harvest_source_id and origin_harvest_source_name as extra metadata properties prior to positing the dataset to CKAN
  • Confirm these properties show up on the dataset after harvest
  • Confirm these properties persist on package_update
@btylerburton btylerburton added H2.0/Harvest-Runner Harvest Source Processing for Harvesting 2.0 H2.0/Harvest-DB Postgres and related DB tickets labels Aug 21, 2024
@Bagesary Bagesary moved this to H2.0 Backlog in data.gov team board Aug 22, 2024
@btylerburton
Copy link
Contributor Author

updated to include harvset_source_name

@FuhuXia
Copy link
Member

FuhuXia commented Aug 26, 2024

This is closely related to #4847.

@btylerburton
Copy link
Contributor Author

Closing in favor of #4847

@github-project-automation github-project-automation bot moved this from H2.0 Backlog to ✔ Done in data.gov team board Aug 26, 2024
@btylerburton btylerburton moved this from ✔ Done to 🗄 Closed in data.gov team board Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
H2.0/Harvest-DB Postgres and related DB tickets H2.0/Harvest-Runner Harvest Source Processing for Harvesting 2.0
Projects
Archived in project
Development

No branches or pull requests

2 participants