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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a publisher, I want to be notified when a new DOI has been minted or significant update to the metadata #283

Closed
Tracked by #30
jordanpadams opened this issue Oct 23, 2021 · 6 comments 路 Fixed by #360
Assignees

Comments

@jordanpadams
Copy link
Member

馃挭 Motivation

...so that I can I can re-ingest the metadata from DataCite

馃摉 Additional Details

鈿栵笍 Acceptance Criteria

Given a DOI service running on pds.nasa.gov
When I perform DOI release
Then I expect ADS (or TBD other publisher) to receive a TBD notification

Given a DOI service running on pds.nasa.gov
When I perform update of TBD fields in DOI metadata for a released DOI
Then I expect ADS (or TBD other publisher) to receive a TBD notification

鈿欙笍 Engineering Details

@jordanpadams jordanpadams added requirement the current issue is a requirement needs:triage labels Oct 23, 2021
@jordanpadams jordanpadams self-assigned this Oct 23, 2021
@jordanpadams jordanpadams added B12.1 enhancement New feature or request and removed requirement the current issue is a requirement needs:triage labels Oct 23, 2021
@jordanpadams jordanpadams removed their assignment Oct 23, 2021
@alexdunnjpl alexdunnjpl self-assigned this Aug 25, 2022
@alexdunnjpl
Copy link
Contributor

@jordanpadams requesting clarification on the following:

  • Who/what is ADS (or more generally, what should determine the recipient(s) of the email notification for a given DOI)?
  • Is the intent is that only the "release" DOICoreAction action performed on any DOI(s), whether by CLI or API, should trigger email notification, or does this apply to the (local-db-only) update DOICoreAction? Sounds like the latter.
  • Should reserve DOICoreActions also trigger this notification?
  • Do you have a minimal spec for the information to be included in the email notification, or are you happy for me to wing it?

@jordanpadams
Copy link
Member Author

jordanpadams commented Sep 8, 2022

  • Who/what is ADS (or more generally, what should determine the recipient(s) of the email notification for a given DOI)?

For now, can we just send this to a configurable email address (e.g. for now use pdsen-doi-prod@jpl.nasa.gov)

  • Is the intent is that only the "release" DOICoreAction action performed on any DOI(s), whether by CLI or API, should trigger email notification, or does this apply to the (local-db-only) update DOICoreAction? Sounds like the latter.
  • Should reserve DOICoreActions also trigger this notification?
  • Do you have a minimal spec for the information to be included in the email notification, or are you happy for me to wing it?

In general, I am just thinking this is a weekly report / breakdown of DOI actions from the past week.

  • New Findable DOIs - list of all new DOIs minted and made findable this week
  • Updated DOIs - list of all findable DOIs that were updated this week (not sure how our states are tracked in our database. I am OK if we just group this together as "New and Updated DOIs"
  • New Reserved DOIs - list of all new DOIs reserved this week

For each DOI record, I am thinking we include:

  • DOI
  • Alternate Identifiers / Identifiers
  • Title

Any other ideas welcome!

@alexdunnjpl
Copy link
Contributor

alexdunnjpl commented Sep 13, 2022

@jordanpadams what does a typical response workflow look like?

If users are likely to do anything iterative to the returned records, I think it would be smart to (in addition to those details) include either a newline-separated set of DOI ids (or whichever id will most-likely be used as an input for a response script) in the body of the email, or attach a json of the corresponding DoiRecords.

If the response will invariably be manual, then I guess it's not so important, but I wonder if someone's likely to want to feed the output into a bash/python script?

We don't track whether a transaction for a findable DOI is the first findable transaction, so if it's not important I'll just distinguish "added last week" and "modified last week (without filtering out new additions, unless it's important that they not appear here, which isn't hard to track but is a minor annoyance to account for the possibility that a DOI might be added on Monday and updated on Wednesday, say, and must appear in both lists)"

@jordanpadams
Copy link
Member Author

@alexdunnjpl Attaching a JSON sounds great. This should be a quick adaptation down the road if this were, for instance, pushing to an API.

We don't track whether a transaction for a findable DOI is the first findable transaction, so if it's not important I'll just distinguish "added last week" and "modified last week (without filtering out new additions, unless it's important that they not appear here, which isn't hard to track but is a minor annoyance to account for the possibility that a DOI might be added on Monday and updated on Wednesday, say, and must appear in both lists)"

This is fine. We basically just want to notify them that they should ping the DataCite API for the latest metadata for DOIs x,y,z. In reality, we don't need all that other information either, but I am thinking this report could potentially be useful outside of this particular use case, so adding some additional metadata, like title, to make the output a little more readable could be beneficial down the road.

@alexdunnjpl
Copy link
Contributor

@jordanpadams in addition to the PR merge, I'll need to set up the crontab on the live system once the new code is deployed. Where/how is doi-service running? I couldn't run docker ps as the group user on the gamma system so I think I'm missing a piece of the puzzle.

@jordanpadams
Copy link
Member Author

@alexdunnjpl I do not believe it is running in docker on the ops machines.

@c-suh @viviant100 can you point Alex to the deployment on pds-gamma as well as the wiki documentation so had can add instructions for starting this new cron job?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants