5253 metrics block ui

doc/sphinx-guides/source/admin/make-data-count.rst

@@ -35,7 +35,19 @@ The most important takeaways from the diagram are:
 Limitations for Dataverse Installations Using Handles Rather Than DOIs
 ----------------------------------------------------------------------
 
-Data repositories using Handles and other identifiers are not supported by Make Data Count but in the notes_ following a July 2018 webinar, you can see the Make Data Count project's response on this topic. In short, the DataCite hub does not want to receive reports for non-DOI datasets. Additionally, citations are only available from the DataCite hub for datasets that have DOIs. 
+Data repositories using Handles and other identifiers are not supported by Make Data Count but in the notes_ following a July 2018 webinar, you can see the Make Data Count project's response on this topic. In short, the DataCite hub does not want to receive reports for non-DOI datasets. Additionally, citations are only available from the DataCite hub for datasets that have DOIs. See also the table below.
+
++---------------------+---------------+------------------+
+|                     | DOIs          | Handles          |
++=====================+===============+==================+
+| **Out of the box**  | Classic       | Classic          |
+|                     | download      | download         |
+|                     | counts        | counts           |
++---------------------+---------------+------------------+
+| **Make Data Count** | MDC views,    | MDC views,       |
+|                     | MDC downloads,| MDC downloads    |
+|                     | MDC citations |                  |
++---------------------+---------------+------------------+
 
 This being said, the Dataverse usage logging can still generate logs and process those logs with Counter Processor to create json that details usage on a dataset level. Dataverse can ingest this locally generated json.
 

doc/sphinx-guides/source/developers/make-data-count.rst

@@ -3,6 +3,9 @@ Make Data Count
 
 Support for Make Data Count is a feature of Dataverse that is described in the :doc:`/admin/make-data-count` section of the Admin Guide. In order for developers to work on the feature, they must install Counter Processor, a Python 3 application, as described below. Counter Processor can be found at https://github.com/CDLUC3/counter-processor
 
+.. contents:: |toctitle|
+        :local:
+
 Architecture
 ------------
 
@@ -13,6 +16,18 @@ There are many components involved in Dataverse's architecture for Make Data Cou
 Dev Environment Setup for Make Data Count
 -----------------------------------------
 
+Generate Fake Metrics Only
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The quickest way to put populate tables with some data is to run the ``MakeDataCountApiIT`` integration test. For more on running integration tests see the :doc:`testing` section. This will populate views and downloads.
+
+To insert a citation you could insert a row like below, changing "72" in the example below with the dataset id for your dataset.
+
+``INSERT INTO datasetexternalcitations (id, citedbyurl, dataset_id) VALUES (1, 'https://doi.org/10.1007/s12520-017-0578-2', 72);``
+
+Full Setup
+~~~~~~~~~~
+
 The recommended way to work on the Make Data Count feature is to spin up an EC2 instance that has both Dataverse and Counter Processor installed. Go to the :doc:`deployment` page for details on how to spin up an EC2 instance and make sure that your Ansible file is configured to install Counter Processor before running the "create" script.
 
 (Alternatively, you can try installing Counter Processor in Vagrant. :download:`setup-counter-processor.sh <../../../../scripts/vagrant/setup-counter-processor.sh>` might help you get it installed.)

src/main/java/edu/harvard/iq/dataverse/makedatacount/DatasetMetricsServiceBean.java

@@ -12,6 +12,7 @@
 import java.util.ListIterator;
 import java.util.Set;
 import java.util.concurrent.Future;
+import java.util.logging.Logger;
 import javax.ejb.EJB;
 import javax.ejb.EJBException;
 import javax.ejb.Stateless;
@@ -32,6 +33,8 @@
 @Named
 @Stateless
 public class DatasetMetricsServiceBean implements java.io.Serializable {
+
+    private static final Logger logger = Logger.getLogger(DatasetMetricsServiceBean.class.getCanonicalName());
 
     @PersistenceContext(unitName = "VDCNet-ejbPU")
     protected EntityManager em;
@@ -58,6 +61,12 @@ public DatasetMetrics getDatasetMetricsByDatasetMonthCountry(Dataset dataset, St
         return null;
     }
 
+    public DatasetMetrics getMetrics(Dataset dataset) {
+        String nullMonthYear = null;
+        String nullCountry = null;
+        return getDatasetMetricsByDatasetForDisplay(dataset, nullMonthYear, nullCountry);
+    }
+
     public DatasetMetrics getDatasetMetricsByDatasetForDisplay(Dataset dataset, String monthYear, String country) {
 
         Long dataset_id = dataset.getId();

src/main/java/propertyFiles/Bundle.properties

@@ -1211,11 +1211,22 @@ dataset.exportBtn.itemLabel.oai_ore=OAI_ORE
 dataset.exportBtn.itemLabel.dataciteOpenAIRE=OpenAIRE
 metrics.title=Metrics
 metrics.title.tip=View more metrics information
-metrics.comingsoon=Coming soon...
-metrics.views=Views
+metrics.dataset.title=Dataset Metrics
+metrics.dataset.tip.default=Aggregated metrics for this dataset.
+metrics.dataset.tip.makedatacount=Metrics collected using Make Data Count standards.
+metrics.dataset.views.tip=Dataset views are combined with aggregated file views.
+metrics.dataset.downloads.default.tip=Total aggregated downloads of files in this dataset.
+metrics.dataset.downloads.makedatacount.tip=Each file download (single or multiple files) increments the download count.
+metrics.dataset.citations.tip=Click for a list of citation URLs.
+metrics.file.title=File Metrics
+metrics.file.tip.default=Metrics for this individual file.
+metrics.file.tip.makedatacount=Individual file downloads are tracked but this is not part of the Make Data Count standard.
+metrics.file.downloads.tip=Total downloads of this file.
+metrics.views={0, choice, 0#Views|1#View|2#Views}
 metrics.downloads={0, choice, 0#Downloads|1#Download|2#Downloads}
-metrics.citations=Citations
-metrics.shares=Shares
+metrics.citations={0, choice, 0#Citations|1#Citation|2#Citations}
+metrics.citations.dialog.header=Dataset Citations
+metrics.citations.dialog.help=Citations for this dataset are retrieved from <a href="https://www.crossref.org" title="Crossref" target="_blank">Crossref</a> via DataCite using Make Data Count standards. For more information about dataset metrics, please refer to the <a href="{0}/{1}/user/dataset-management.html#dataset-metrics-user" title="Dataset Metrics - Dataverse User Guide" target="_blank">User Guide</a>.
 dataset.publish.btn=Publish
 dataset.publish.header=Publish Dataset
 dataset.rejectBtn=Return to Author

src/main/webapp/dataset-citation.xhtml

@@ -7,10 +7,10 @@
      xmlns:o="http://omnifaces.org/ui"
      xmlns:jsf="http://xmlns.jcp.org/jsf">
 
-    <div class="row citation-block">
-        <div class="col-xs-12  #{DatasetPage.workingVersion.deaccessioned ? 'alert alert-danger bg-danger' : 'alert alert-info bg-citation'}">
+    <div class="#{widgetWrapper.widgetView ? 'col-sm-12' : 'col-sm-9'} citation-block">
+        <div class="col-sm-12 #{DatasetPage.workingVersion.deaccessioned ? 'alert alert-danger bg-danger' : 'alert alert-info bg-citation'}">
             <div class="row ">
-                <div class="#{DatasetPage.workingVersion.deaccessioned ? 'col-xs-12' : 'col-xs-7 col-md-8'} citation">
+                <div class="col-sm-12 citation">
                     <span class="citation-select" onclick="if (event.target) { selectText(event.target); } else{ selectText(this); }">
                         <h:outputText value="#{DatasetPage.displayCitation}" escape="false"/>
                     </span>
@@ -21,7 +21,7 @@
                     <span class="glyphicon glyphicon-question-sign text-primary" jsf:rendered="#{DatasetPage.workingVersion.deaccessioned}" 
                           data-toggle="tooltip" data-placement="top" data-original-title="#{bundle['dataset.cite.title.deassessioned']}"/>
                 </div>
-                <div class="col-xs-5 col-md-4 text-right citation-download" jsf:rendered="#{!DatasetPage.workingVersion.deaccessioned}">
+                <div class="col-sm-6 citation-download vcenter" jsf:rendered="#{!DatasetPage.workingVersion.deaccessioned}">
                     <div class="dropdown">
                         <button type="button" class="btn btn-default dropdown-toggle downloadCitation" data-toggle="dropdown">
                             <span class="glyphicon glyphicon-list"/> #{bundle['dataset.cite.downloadBtn']} <span class="caret"></span>
@@ -44,7 +44,9 @@
                             </li>
                         </ul>
                     </div>
-                    <div class="small text-muted text-right citation-standards"><h:outputText value="#{bundle['dataset.cite.standards.tip']}" escape="false"/></div>
+                </div>
+                <div class="col-sm-6 text-right small text-muted citation-standards vcenter" jsf:rendered="#{!DatasetPage.workingVersion.deaccessioned}">
+                    <h:outputText value="#{bundle['dataset.cite.standards.tip']}" escape="false"/>
                 </div>
             </div>
         </div>