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

10217 source name harvesting client #11217

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

luddaniel
Copy link
Contributor

@luddaniel luddaniel commented Feb 5, 2025

What this PR does / why we need it:

This PR will help admin to customize their harvesting clients name in metadata source facet.
A new field called sourceName, a nullable TEXT, has been added.
If set, it will overload the nickName in metadata source facet while indexing harvested dataset.
This will allow to have many harvesting client to be under the same sourceName if wished.

Please have in mind that displaying nickName or sourceName requires to activate the feature flag index-harvested-metadata-source.

This PR contains some refactoring and update on guide documentation.

Which issue(s) this PR closes:

Special notes for your reviewer:

I tested this code from user interface (Dashboard > create and edit havesting client popup) .
I tested this code from API also.
I was not able to test the HarvestingClientsIT in localhost.

My samples for testing :

{
"nickName": "CIRAD_1",
"dataverseAlias": "root",
"type": "oai",
"style": "dataverse",
"harvestUrl": "https://dataverse.cirad.fr/oai",
"archiveUrl": "https://dataverse.cirad.fr",
"archiveDescription": "This Dataset is harvested from our partners. Clicking the link will take you directly to the archival source of the data.",
"metadataFormat": "oai_dc",
"set": "entrepot_recherche_data_gouv",
"schedule": "none",
"allowHarvestingMissingCVV": false,
"useOaiIdentifiersAsPids": false
}

{
"nickName": "IRD",
"sourceName": "RDG Partners",
"dataverseAlias": "root",
"type": "oai",
"style": "dataverse",
"harvestUrl": "https://dataverse.ird.fr//oai",
"archiveUrl": "https://dataverse.ird.fr",
"archiveDescription": "This Dataset is harvested from our partners. Clicking the link will take you directly to the archival source of the data.",
"metadataFormat": "oai_dc",
"schedule": "none",
"allowHarvestingMissingCVV": false,
"useOaiIdentifiersAsPids": false
}

{
"nickName": "progedo",
"sourceName": "RDG Partners",
"dataverseAlias": "root",
"type": "oai",
"style": "default",
"harvestUrl": "https://data.progedo.fr/oai",
"archiveUrl": "https://data.progedo.fr",
"archiveDescription": "This Dataset is harvested from our partners. Clicking the link will take you directly to the archival source of the data.",
"metadataFormat": "oai_dc",
"schedule": "none",
"allowHarvestingMissingCVV": true,
"useOaiIdentifiersAsPids": false
}

Does this PR introduce a user interface change?:

The new field is visible in both creation and edition harvesting client popup :

sourcename popup

Examples of harvesting result in metadata source :

harvesting clients
metadata sources

Please note that both progedo and IRD are merged under "RDG Partners" in metadata source and CIRAD is displayed under CIRAD because the sourceName is not set.

Is there a release notes update needed for this change?

Yes

@coveralls
Copy link

coveralls commented Feb 5, 2025

Coverage Status

coverage: 22.751% (-0.001%) from 22.752%
when pulling 668ac77 on Recherche-Data-Gouv:10217-source-name-harvesting-client
into aebec05 on IQSS:develop.

@luddaniel luddaniel force-pushed the 10217-source-name-harvesting-client branch from cb3fba3 to 668ac77 Compare February 5, 2025 15:19
@cmbz cmbz added Size: 10 A percentage of a sprint. 7 hours. Feature: Harvesting GREI 3 Search and Browse labels Feb 7, 2025
@pdurbin pdurbin added this to the 6.6 milestone Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Harvesting GREI 3 Search and Browse Size: 10 A percentage of a sprint. 7 hours.
Projects
Status: SPRINT READY
Status: 🚧 Dev by Recherche Data Gouv
Development

Successfully merging this pull request may close these issues.

Add Source/Server name to OAI-PMH Harvesting clients
4 participants