Admin Guide

This guide documents the functionality only available to superusers (such as “dataverseAdmin”) through the Dashboard as well as command line utilities of interest to sysadmins.

Contents:

• Dashboard
  • Harvesting
    • Harvesting Clients
    • Harvesting Servers
  • Metadata Export
  • Users
  • Move Data
• External Tools
  • Inventory of External Tools
  • Managing External Tools
    • Adding External Tools to a Dataverse Installation
    • Listing All External Tools in a Dataverse Installation
    • Showing an External Tool in a Dataverse Installation
    • Removing an External Tool From a Dataverse Installation
  • Testing External Tools
    • File Level vs. Dataset Level
    • File Level Explore Tools
    • File Level Preview Tools
    • File Level Query Tools
    • File Level Configure Tools
    • Dataset Level Explore Tools
    • Dataset Level Configure Tools
  • Writing Your Own External Tool
• Discoverability
  • DataCite Integration
  • OAI-PMH (Harvesting)
  • Machine-Readable Metadata on Dataset Landing Pages
    • Dublin Core HTML Meta Tags
    • Schema.org JSON-LD/Croissant Metadata
    • Signposting
  • Additional Discoverability Through Integrations
• Managing Harvesting Clients
  • Your Dataverse Installation as a Metadata Harvester
  • Managing Harvesting Clients
    • How to Stop a Harvesting Run in Progress
    • What if a Run Fails?
    • Harvesting Non-OAI-PMH
• Managing Harvesting Server and Sets
  • Your Dataverse Installation as an OAI server
  • How does it work?
  • OAI Sets
    • Important: New Solr schema required!
  • OAI Set updates
• Metadata Customization
  • Introduction
  • About the metadata block TSV
    • #metadataBlock properties
    • #datasetField (field) properties
    • #controlledVocabulary (enumerated) properties
    • FieldType definitions
    • displayFormat variables
  • Metadata Block Setup
    • Exploring Metadata Blocks
    • Setting Up a Dev Environment for Testing
    • Editing TSV files
    • Loading TSV files into a Dataverse Installation
    • #metadataBlock properties
    • #datasetField (field) properties
    • #controlledVocabulary (enumerated) properties
    • Enabling a Metadata Block
    • Updating the Solr Schema
  • Reloading a Metadata Block
  • Using External Vocabulary Services
  • Protecting MetadataBlocks
  • Tips from the Dataverse Community
  • Development Tasks Specific to Changing Fields in Core Metadata Blocks
    • Making a Field Multi-Valued
  • Footnotes
• Metadata Export
  • Automatic Exports
  • Batch Exports Through the API
  • Export Failures
  • Downloading Metadata via GUI
  • Downloading Metadata via API
  • Exporter Configuration
• Dataverse Installation Application Timers
  • Dedicated timer server in a Dataverse Installation server cluster
  • Harvesting Timers
  • Metadata Export Timer
  • Saved Searches Links Timer
  • Known Issues
• Make Data Count
  • Introduction
  • Architecture
  • Limitations for Dataverse Installations Using Handles Rather Than DOIs
  • Configuring Your Dataverse Installation for Make Data Count Views and Downloads
    • Enable Logging for Make Data Count
    • Enable or Disable Display of Make Data Count Metrics
    • Configure Counter Processor
    • Populate Views and Downloads for the First Time
    • Populate Views and Downloads Nightly
    • Sending Usage Metrics to the DataCite Hub
  • Configuring Your Dataverse Installation for Make Data Count Citations
  • Retrieving Make Data Count Metrics from the DataCite Hub
  • Retrieving Make Data Count Metrics from a Dataverse Installation
• Integrations
  • Getting Data In
    • GitHub
    • Dropbox
    • Open Science Framework (OSF)
    • RSpace
    • Open Journal Systems (OJS)
    • Renku
    • Amnesia
    • SampleDB
    • RedCap
    • GitLab
    • iRODS
    • Integrations Dashboard
    • Globus
    • DataLad
  • Embedding Data on Websites
    • OpenScholar
  • Analysis and Computation
    • Data Explorer
    • Compute Button
    • Whole Tale
    • Binder
    • Renku
    • Avgidea Data Search
    • JupyterHub
  • Discoverability
    • SHARE
    • Geodisy
    • DataONE
  • Research Data Preservation
    • Archivematica
    • RDA BagIt (BagPack) Archiving
  • Future Integrations
• User Administration
  • Manage Users
    • List Users via API
  • Merge User Accounts
  • Change User Identifier
  • Delete a User
  • Deactivate a User
  • Confirm Email
  • Deleting an API Token
  • Letting Users Manage Notifications
• Managing Datasets and Dataverse Collections
  • Dataverse Collections
    • Delete a Dataverse Collection
    • Move a Dataverse Collection
    • Link a Dataverse Collection
    • Unlink a Dataverse Collection
    • List Dataverse Collection Links
    • Add Dataverse Collection RoleAssignments to Dataverse Subcollections
    • Configure a Dataverse Collection to Store All New Files in a Specific File Store
    • Configure a Dataverse Collection to Allow Use of a Given Curation Label Set
  • Datasets
    • Move a Dataset
    • Link a Dataset
    • List Collections that are Linked from a Dataset
    • Unlink a Dataset
    • Mint a PID for a File That Does Not Have One
    • Mint PIDs for all unregistered published files in the specified collection
    • Mint PIDs for ALL unregistered files in the database
    • Mint a New DOI for a Dataset with a Handle
    • Update Target URL for a Published Dataset at the PID provider
    • Update Target URL for all Published Datasets at the PID provider
    • Update Metadata for a Published Dataset at the PID provider
    • Update Metadata for all Published Datasets at the PID provider
    • Check for Unreserved PIDs and Reserve Them
    • Make Metadata Updates Without Changing Dataset Version
    • Diagnose Constraint Violations Issues in Datasets
    • Configure a Dataset to Store All New Files in a Specific File Store
    • Configure a Dataset to Allow Use of a Curation Label Set
• Solr Search Index
  • Full Reindex
    • Clear and Reindex
      • Index and Database Consistency
      • Clearing ALL Data from Solr
      • Start Async Reindex
    • Reindex in Place
      • Clear Index Timestamps
      • Start or Continue Async Reindex
  • Manual Reindexing
    • Reindexing Dataverse Collections
    • Reindexing Datasets
      • Clearing a Dataset from Solr
  • Manually Querying Solr
• IP Groups
  • Listing IP Groups
  • Creating an IP Group
  • Listing an IP Group
  • Deleting an IP Group
• Mail Domain Groups
  • Listing Mail Domain Groups
  • Listing a specific Mail Domain Group
  • Creating a Mail Domain Group
    • Matching with Domains or Regular Expressions
  • Updating a Mail Domain Group
  • Deleting a Mail Domain Group
• Storage Quotas for Collections
• Monitoring
  • Operating System Monitoring
    • Munin
  • HTTP Traffic
    • Monitoring HTTP Traffic from the Client Side
    • Monitoring HTTP Traffic from the Server Side
    • AWStats
  • Database Connection Pool Used by App Server
  • actionlogrecord
    • An Important Note about ActionLogRecord Table:
  • Edit Draft Versions Logging
  • Solr Indexing Failures Logging
  • EJB Timers
  • AWS RDS
  • MicroProfile Metrics endpoint
• Reporting Tools and Common Queries
• Maintenance
• Backups
• Troubleshooting
  • Using Dataverse Installation APIs to Troubleshoot and Fix Problems
    • A Dataset Is Locked And Cannot Be Edited or Published
    • Someone Created Spam Datasets and I Need to Delete Them
    • A User Needs Their Account to Be Converted From Institutional (Shibboleth), ORCID, Google, or GitHub to Something Else
  • Ingest
    • Long-Running Ingest Jobs Have Exhausted System Resources
  • Payara
    • Finding the Payara Log File
    • Increasing Payara Logging
  • Deployment fails, “EJB Timer Service not available”
  • Timer Not Working
  • Constraint Violations Issues
  • Many Files with a File Type of “Unknown”, “Application”, or “Binary”
  • What’s with this Table “ActionLogRecord” in Our Database, It Seems to be Growing Uncontrollably?
  • Getting Help