From 40626beee7d6b0421a6d8079a370531456e39af8 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Thu, 28 Oct 2021 13:38:55 -0400 Subject: [PATCH 1/7] updates to make clearer the format for subcollections --- doc/sphinx-guides/source/admin/harvestserver.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index 95e68168893..481f3a65fe3 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -81,7 +81,11 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/NNN"`` - where NNN is the database id of the Dataverse collection object (consult the Dataverse table of the SQL database used by the application to verify the database id). + where NNN is the database id of the Dataverse collection (consult the Dataverse table of the SQL database used by the application to verify the database id). If the Dataverse collection has one or more parent collections, it has to include the database IDs of each of the collection's parent collections, for example: + + ``subtreePaths:"/AAA/NNN"`` + + where NNN is the database id of the Dataverse collection which is a child of the collection with the AAA database id. - A query to find all the dataset by a certain author: From 49ffbd0c8f49d74dbfb62c79b4637effd33c1629 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Thu, 28 Oct 2021 13:43:54 -0400 Subject: [PATCH 2/7] rephrasing. --- doc/sphinx-guides/source/admin/harvestserver.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index 481f3a65fe3..356e5ac3901 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -85,7 +85,7 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/AAA/NNN"`` - where NNN is the database id of the Dataverse collection which is a child of the collection with the AAA database id. + where NNN is the database id of the Dataverse collection containing the desired dataset and AAA is the database ID of the parent collection. - A query to find all the dataset by a certain author: From ab89dc57a01a56dbebbe08fae517cacb37ed6096 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 28 Oct 2021 16:34:21 -0400 Subject: [PATCH 3/7] Update harvestserver.rst Tried to clarify that the path should include all parent collections up to but excluding the Root collection. Also added @pdurbin's suggestion of using an API endpoint to get the Dataverse collection's database ID. It might be helpful to link to the section of the API Guide that documents that endpoint, which I think is https://guides.dataverse.org/en/5.7/api/native-api.html?highlight=unlock#view-a-dataverse-collection, but I don't know the best way to do this in this rst file. Tried looking through this rst file to for an example but I'm still not sure. @pdurbin could you add a link behind ""View a Dataverse Collection" API endpoint"? --- doc/sphinx-guides/source/admin/harvestserver.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index 356e5ac3901..b89bb9f6d39 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -81,11 +81,11 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/NNN"`` - where NNN is the database id of the Dataverse collection (consult the Dataverse table of the SQL database used by the application to verify the database id). If the Dataverse collection has one or more parent collections, it has to include the database IDs of each of the collection's parent collections, for example: + where NNN is the database ID of the Dataverse collection (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the "View a Dataverse Collection" API endpoint). If the Dataverse collection has one or more parent collections, the subtreePaths query has to include the database IDs of each of the collection's parent collections, up to but excluding the "Root" collection, for example: - ``subtreePaths:"/AAA/NNN"`` + ``subtreePaths:"/AAA/BBB/NNN"`` - where NNN is the database id of the Dataverse collection containing the desired dataset and AAA is the database ID of the parent collection. + where NNN is the database id of the Dataverse collection containing the desired dataset and AAA and BBB are the database IDs of the parent collections. - A query to find all the dataset by a certain author: From ee12d536d3ec40d230f8a820a43706e69335af81 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 28 Oct 2021 16:54:16 -0400 Subject: [PATCH 4/7] Update harvestserver.rst Small grammar edit. --- doc/sphinx-guides/source/admin/harvestserver.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index b89bb9f6d39..e540bb14f0d 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -81,7 +81,7 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/NNN"`` - where NNN is the database ID of the Dataverse collection (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the "View a Dataverse Collection" API endpoint). If the Dataverse collection has one or more parent collections, the subtreePaths query has to include the database IDs of each of the collection's parent collections, up to but excluding the "Root" collection, for example: + where NNN is the database ID of the Dataverse collection (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the "View a Dataverse Collection" API endpoint). If the Dataverse collection has one or more parent collections, the subtreePaths query has to include the database IDs of each of the collection's parent collections, up to but excluding the "Root" collection. For example: ``subtreePaths:"/AAA/BBB/NNN"`` From 7b71433f26d04c3f076192bf440f98f854de27c5 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Thu, 28 Oct 2021 16:58:56 -0400 Subject: [PATCH 5/7] link to API guide https://github.com/IQSS/dataverse.harvard.edu/issues/124 --- doc/sphinx-guides/source/admin/harvestserver.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index e540bb14f0d..a8ddda2ba8f 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -81,7 +81,7 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/NNN"`` - where NNN is the database ID of the Dataverse collection (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the "View a Dataverse Collection" API endpoint). If the Dataverse collection has one or more parent collections, the subtreePaths query has to include the database IDs of each of the collection's parent collections, up to but excluding the "Root" collection. For example: + where NNN is the database ID of the Dataverse collection (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the :ref:`view-dataverse` API endpoint). If the Dataverse collection has one or more parent collections, the subtreePaths query has to include the database IDs of each of the collection's parent collections, up to but excluding the "Root" collection. For example: ``subtreePaths:"/AAA/BBB/NNN"`` From 08521462d96e8ba942cf0a9def8ec32edf9f6e05 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Thu, 28 Oct 2021 17:27:00 -0400 Subject: [PATCH 6/7] Update harvestserver.rst Capitalizing another "ID" --- doc/sphinx-guides/source/admin/harvestserver.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index a8ddda2ba8f..a75fe9a2085 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -85,7 +85,7 @@ Some useful examples of search queries to define OAI sets: ``subtreePaths:"/AAA/BBB/NNN"`` - where NNN is the database id of the Dataverse collection containing the desired dataset and AAA and BBB are the database IDs of the parent collections. + where NNN is the database ID of the Dataverse collection containing the desired dataset and AAA and BBB are the database IDs of the parent collections. - A query to find all the dataset by a certain author: From 97fb918b214362435f989c244b5c3ed70c69d937 Mon Sep 17 00:00:00 2001 From: Julian Gautier Date: Sat, 30 Oct 2021 13:40:47 -0400 Subject: [PATCH 7/7] Update harvestserver.rst From our edits to the section about the subtreePaths query, I copied the extra tip about using an API endpoint to get the database ID to the parentId query. That's the only other place, at least on this page, where the user needs to know what the database ID is and is given tips for how to get it. --- doc/sphinx-guides/source/admin/harvestserver.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/sphinx-guides/source/admin/harvestserver.rst b/doc/sphinx-guides/source/admin/harvestserver.rst index a75fe9a2085..4e3f6ac0038 100644 --- a/doc/sphinx-guides/source/admin/harvestserver.rst +++ b/doc/sphinx-guides/source/admin/harvestserver.rst @@ -23,7 +23,7 @@ of such instances. The email portion of :ref:`systemEmail` will be visible via OAI-PMH (from the "Identify" verb). -How does it work? +How does it work? ----------------- Only the published, unrestricted datasets in your Dataverse installation can @@ -69,11 +69,11 @@ Some useful examples of search queries to define OAI sets: Note also that the search terms limiting the results to published and local datasets **are added to the query automatically**, so you don't need to worry about that. -- A query to create a set to include the datasets from a specific Dataverse collection: +- A query to create a set to include the datasets from a specific Dataverse collection: ``parentId:NNN`` - where NNN is the database id of the Dataverse collection object (consult the Dataverse table of the SQL database used by the application to verify the database id). + where NNN is the database id of the Dataverse collection object (to verify the database ID, consult the Dataverse table of the SQL database used by the application or use the :ref:`view-dataverse` API endpoint). Note that this query does **not** provide datasets that are linked into the specified Dataverse collection. @@ -87,13 +87,13 @@ Some useful examples of search queries to define OAI sets: where NNN is the database ID of the Dataverse collection containing the desired dataset and AAA and BBB are the database IDs of the parent collections. -- A query to find all the dataset by a certain author: +- A query to find all the dataset by a certain author: ``authorName:YYY`` where YYY is the name. -- Complex queries can be created with multiple logical AND and OR operators. For example, +- Complex queries can be created with multiple logical AND and OR operators. For example, ``(authorName:YYY OR authorName:ZZZ) AND dsPublicationDate:NNNN``