Troubleshoot and Maintain Processes

Note: These utilities support diagnostic and troubleshooting activities. Do not use these utilities until you contact the Dataverse Network Project at dvn_support@help.hmdc.harvard.edu for assistance.

You can perform basic maintenance on Dataverse Network functions by using the following Network utilities:

  • StudyLock utilities - Release file locks on study files when needed.
  • Index utilities - Create a search index.
  • Export utilities - Select files and export them.
  • Harvest utilities - Harvest selected studies from another Network.
  • File utilities - Select files and apply the JHOVE file validation process to them.
  • Import utilities - Import multiple study files by using this custom batch process.
  • Delete utilities - Delete multiple studies at one time.

Read the following topics for detailed information about how to use these tools:

StudyLock Utilities

If a file is processing in any study on the Network, a lock is set for that file to prevent users from opening the file. If for any reason the file lock does not resolve properly when the file is no longer processing, you can remove that lock and free the file for use by others.

To remove a file lock on a study file:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the StudyLock Utilities arrow.
    You see the Current Locks list, which identifies all files in the Network that currently are locked to use by the system.
  4. To remove a lock from a selected file, find the appropriate DVN database ID for the file and enter that ID in the lock field.
  5. Click Remove Lock.
    The ID for that file is removed from the Current Locks list.

Index Utilities

You can refresh the search index manually for the Network. This ensures that search functions used in the Network include the contents of the selected studies. You can reindex all studies in the Network, all studies in a selected dataverse, or selected studies.

To refresh, or reindex, the search index in the Network:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Index Utilities arrow.
    You see the Index options.
  4. To reindex all studies in the Network, click the Index All button.
    To index all studies in a selected dataverse, enter the DVN database ID of the dataverse that you choose to index in the Index Dataverse field. Then, click the Index Dataverse button.
    To index specific studies in any dataverse on the Network, enter the DVN database IDs for the studies that you choose to index in the Index Studies field. Then, click the Index Studies button.

All studies that you selected are added to the search index in the Network.

Export Utilities

You can export manually all or selected studies, at any time.

To export studies manually:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Export Utilities arrow.
    You see the Export options.
  4. To export all updated studies in the Network in all export formats, click the Run Export button.
    To update the membership of OAI sets used in harvesting (including the no set membership), click the Update Harvested Studies button.
    To perform a custom export:

    1. Use the Select Export Format pull-down list and select the format in which you choose to export studies.
      The default is to export to all formats.
    2. Select studies and export them:
      • To export all studies in the Network, click the Export All button.
      • To export all studies in a selected dataverse only, enter the selected dataverse's DVN database ID in the Export Dataverse field, and then click the Export Dataverse button.
      • To export selected studies owned by any dataverses, enter the DVN database IDs for the studies in the Export Studies field, and then click the Export Studies button.

Harvest Utilities

You can harvest a specific study manually, at any time. Before you can harvest manually, the harvesting dataverse that owns the study must be configured and harvested successfully at least one time.

To harvest a selected study:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Harvest Utilities arrow.
    You see the Harvest options.
  4. Use the DV pull-down list and select the dataverse that owns the study you choose to harvest.
  5. In the Harvest Study field, enter the harvest identifier of the study that you choose to harvest.
    Use the ID from the originating server, not the DVN Study Global ID.
  6. Click the Harvest Study button.
    You receive email when the study is harvested. If the harvest process does not succeed, you also receive email notification of the failure.

File Utilities

You can apply JHOVE file format validation manually to study files, and determine the type of file. Note that any subsettable files, for which file types are provided, are not validated.

To determine the file type for files uploaded to specific studies:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the File Utilities arrow.
    You see the File options.
  4. In the Determine File Types field, enter the DVN dataverse ID of the study or studies for which you choose to determine file types.
  5. Click the Determine File Types button.
    A message is displayed, stating that your request completed, and listing the file types for any applicable files.

Import Utilities

You can import groups of study files or import one study file to a dataverse by using a batch file utility.

Before you use this import utility, you must organize your files in the following manner:

  1. If you plan to import multiple files or studies, create a master directory to hold all content that you choose to import.
  2. Create a separate subdirectory for each study that you choose to import.
    The directory name is not important.
  3. In each directory, place a file called study.xml and use that file to hold the XML-formatted record for one study.
    Note: Do not include file description elements in the study.xml file. Including those fields results in the addition of multiple blank files to that study..
  4. Also place in the directory any additional files that you choose to upload for that study.

See the following topics for detailed information:

Import Multiple Studies

To import a group of studies that are organized as described in Import Utilities:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Import Utilities arrow.
    You see the Import options.
  4. Use the File Format pull-down list and choose the import standard with which your study.xml files comply.
  5. Use the Dataverse pull-down list and choose the dataverse to which you choose to import your studies.
  6. Enter the fully qualified master directory name in the Batch Import field, and then click the Batch Import button.
    You see a message on the Import options page that indicates if your import was successful or did not complete.

Import One Study

To import a single study that is in an XML-formatted study.xml file:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Import Utilities arrow.
    You see the Import options.
  4. Use the File Format pull-down list and choose the import standard with which your study.xml files comply.
  5. Use the Dataverse pull-down list and choose the dataverse to which you choose to import your studies.
  6. Click the Choose File button to select the file that you choose to import.
    A file browser window opens.
  7. In the file browser window, navigate to your study file and select that file.
  8. Click the Import File button to import your file.
    You see a message on the Import options page that indicates if your import was successful or did not complete.

Delete Utilities

To delete multiple studies in the Network at one time:

  1. Log in and navigate to the Network Options page.
  2. Scroll to Network Utilities and click Troublshoot, Maintain Processes.
    You see the Dataverse Network Utiities page.
  3. Click the Delete Utilities arrow.
    You see the Delete Utilities field.
  4. Enter the Study ID of each study that you choose to delete from the network.
  5. Click Delete Studies.
    You are prompted to confirm the Delete action.
  6. Click OK to complete the Delete action.
    The studies with the Study IDs that you entered are removed from the Network, and you see the message Delete request completed followed by the list of studies deleted.