diff --git a/doc/sphinx-guides/source/admin/make-data-count.rst b/doc/sphinx-guides/source/admin/make-data-count.rst index d8fc51db002..157b71d3e20 100644 --- a/doc/sphinx-guides/source/admin/make-data-count.rst +++ b/doc/sphinx-guides/source/admin/make-data-count.rst @@ -68,7 +68,7 @@ If you wish to start logging in advance of setting up other components, or wish After you have your first day of logs, you can process them the next day. Enable or Disable Display of Make Data Count Metrics -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default, when MDC logging is enabled (when ``:MDCLogPath`` is set), Dataverse will display MDC metrics instead of it's internal (legacy) metrics. You can avoid this (e.g. to collect MDC metrics for some period of time before starting to display them) by setting ``:DisplayMDCMetrics`` to false. @@ -135,11 +135,15 @@ Once you are satisfied with your testing, you should contact support@datacite.or - Views ("investigations" in COUNTER) - Downloads ("requests" in COUNTER) +.. _MDC-updateCitationsForDataset: + Configuring Dataverse for Make Data Count Citations --------------------------------------------------- Please note: as explained in the note above about limitations, this feature is not available to installations of Dataverse that use Handles. +To configure Dataverse to pull citations from the test vs. production DataCite server see :ref:`doi.mdcbaseurlstring` in the Installation Guide. + Please note that in the curl example, Bash environment variables are used with the idea that you can set a few environment variables and copy and paste the examples as is. For example, "$DOI" could become "doi:10.5072/FK2/BL2IBM" by issuing the following export command from Bash: ``export DOI="doi:10.5072/FK2/BL2IBM"`` diff --git a/doc/sphinx-guides/source/admin/troubleshooting.rst b/doc/sphinx-guides/source/admin/troubleshooting.rst index 1b22a58555b..eb7872bac20 100644 --- a/doc/sphinx-guides/source/admin/troubleshooting.rst +++ b/doc/sphinx-guides/source/admin/troubleshooting.rst @@ -32,12 +32,28 @@ A User Needs Their Account to Be Converted From Institutional (Shibboleth), ORCI See :ref:`converting-shibboleth-users-to-local` and :ref:`converting-oauth-users-to-local`. +.. _troubleshooting-glassfish: + Glassfish --------- -``server.log`` is the main place to look when you encounter problems. Hopefully an error message has been logged. If there's a stack trace, it may be of interest to developers, especially they can trace line numbers back to a tagged version. +.. _glassfish-log: + +Finding the Glassfish Log File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``/usr/local/glassfish4/glassfish/domains/domain1/logs/server.log`` is the main place to look when you encounter problems (assuming you installed Glassfish in the default directory). Hopefully an error message has been logged. If there's a stack trace, it may be of interest to developers, especially they can trace line numbers back to a tagged version or commit. Send more of the stack trace (the entire file if possible) to developers who can help (see "Getting Help", below) and be sure to say which version of Dataverse you are running. + +.. _increase-glassfish-logging: + +Increasing Glassfish Logging +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For debugging purposes, you may find it helpful to increase logging levels as mentioned in the :doc:`/developers/debugging` section of the Developer Guide. +For debugging purposes, you may find it helpful to temporarily increase logging levels. Here's an example of increasing logging for the Java class behind the "datasets" API endpoints: + +``./asadmin set-log-levels edu.harvard.iq.dataverse.api.Datasets=FINE`` + +For more on setting log levels, see the :doc:`/developers/debugging` section of the Developer Guide. Our guides focus on using the command line to manage Glassfish but you might be interested in an admin GUI at http://localhost:4848 @@ -100,3 +116,8 @@ Many Files with a File Type of "Unknown", "Application", or "Binary" -------------------------------------------------------------------- From the home page of a Dataverse installation you can get a count of files by file type by clicking "Files" and then scrolling down to "File Type". If you see a lot of files that are "Unknown", "Application", or "Binary" you can have Dataverse attempt to redetect the file type by using the :ref:`Redetect File Type ` API endpoint. + +Getting Help +------------ + +If the troubleshooting advice above didn't help, contact any of the support channels mentioned in the :ref:`support` section of the Installation Guide. diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 0466b72706f..f252ca310ba 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -962,6 +962,8 @@ See also these related database settings below: doi.mdcbaseurlstring ++++++++++++++++++++ +This configuration option affects the ``updateCitationsForDataset`` API endpoint documented under :ref:`MDC-updateCitationsForDataset` in the Admin Guide. + As of this writing, "https://api.datacite.org" (DataCite) and "https://api.test.datacite.org" (DataCite Testing) are the main valid values. Out of the box, Dataverse is configured to use a test DataCite MDC base URL string. You can delete it like this: diff --git a/src/main/java/edu/harvard/iq/dataverse/api/MakeDataCountApi.java b/src/main/java/edu/harvard/iq/dataverse/api/MakeDataCountApi.java index 5722acc11ec..da827de9c1f 100644 --- a/src/main/java/edu/harvard/iq/dataverse/api/MakeDataCountApi.java +++ b/src/main/java/edu/harvard/iq/dataverse/api/MakeDataCountApi.java @@ -145,6 +145,7 @@ public Response updateCitationsForDataset(@PathParam("id") String id) throws Mal baseUrl="https://api.datacite.org"; } URL url = new URL(baseUrl + "/events?doi=" + authorityPlusIdentifier + "&source=crossref"); + logger.fine("Requesting citations from " + url); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); int status = connection.getResponseCode();