This guide supports version 1.3 of the Dataverse Network application.
In addition to all other options available to all other users, Network Admins also can perform the following tasks:
Dataverses, Harvesting, Exporting, and OAI Sets
A standard dataverse holds uploaded studies and defined collections.
A harvesting dataverse culls data from other dataverses or Networks by using the OAI protocols. You cannot change the contents of a harvesting dataverse, but you can do any of the following:
- Restrict access to the dataverse and its contents
- Organize the contents into collections
- Customize the homepage layout, name, and description
You can create and manage the following aspects for all dataverses in the Network:
Create a New Dataverse
To create a standard dataverse:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Create a New Dataverse.
You see the Add a New Dataverse page.
- Click the radio button next to the type of dataverse that you choose to create.
A Scholar dataverse requires that you enter first and last name when you create the dataverse. Choose this option if you are an individual publishing your own studies.
A Basic dataverse does not require first and last name values. Choose this option if you are publishing or collecting studies for groups, publications, or other communities.
- If you selected a Scholar dataverse type, then enter a First Name and Last Name for your dataverse.
These values become the default dataverse homepage name.
- Enter an affiliation for the dataverse.
For example, if this dataverse if for a Scholar, then enter the university or department in which the scholar works.
- Enter the full name for the dataverse homepage.
You can change the default value for a Scholar dataverse, if you choose.
This is the name that is displayed on the dataverse's homepage.
- Enter an alias for the dataverse.
This is the user-friendly URL by which the dataverse is reached directly, and which can be used as a link to the dataverse from external web pages.
- For a Basic dataverse, use the Group Assignment pull-down list and choose the dataverse group in which to add this dataverse.
- Click Save Changes to keep your changes, or click Cancel to lose your changes.
On the Network homepage Coming Soon tab, the dataverse is displayed.
Create a New Harvesting Dataverse
You can create two types of harvesting dataverse:
- OAI Harvesting Dataverse - This type of dataverse harvests data from OAI servers.
Refer to Open Archives Initiative for information about OAI services.
- Nesstar Harvesting Dataverse - This type of dataverse harvests data from Nesstar servers.
Refer to Nesstar, owned by Norwegian Social Science Data Services (NSD), for information about Nesstar services.
When a dataverse harvests from another service, the first harvesting is a full harvest. For all other harvesting, an update is performed.
See the following topics for detailed information about how to create these dataverses:
Create a New OAI Harvesting Dataverse
To create a harvesting dataverse:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Scroll to the Dataverses, Harvesting, Exporting and OAI Sets options, and then click Create a New Harvesting Dataverse.
You see the Harvest Dataverse page.
- In the Harvest Type field, click the OAI Server radio button.
- Enter a Name for the dataverse, which is displayed on the Network homepage.
- Enter an Alias, which is the short name for the dataverse used to build the site's URL.
This field is case sensitive.
- Enter the Server URL for the network server from which you choose to harvest data, and then click the Validate button.
If the server is valid, additional Harvesting fields are displayed for further configuration. If the server is not valid, the error message Please enter a valid url is displayed. Correct the server name, and then click Validate again.
An example valid server is the IQSS DVN OAI server, http://dvn.iq.harvard.edu/dvn/OAIHandler.
- If harvesting sets are configured for the OAI server that you entered, then use the Harvesting Set pull-down list to select a valid set option.
The default is No Set (harvest all).
- Use the Harvesting Format pull-down list to select the XML format to use in harvesting from that server.
Possible values are DC (Dublin Core) and DDI, depending on the server's configuration.
- Use the Handle Registration pull-down list to select whether to register with HANDLE.NET any harvested studies that have these identifiers on the server from which you harvest them.
- You can enable harvesting on a scheduled basis, to refresh the contents of a harvest dataverse and keep it current with the server from which you harvest.
To enable scheduled harvesting:
- Click the check box in the Schedule Harvesting field.
- Use the Scheduled Harvesting Period pull-down list to select Harvest daily or Harvest weekly.
If you do not choose an option, there is no schedule applied to the harvesting function.
- If you choose Harvest daily, in the Scheduled Harvesting Hour of Day field set the time of day at which to perform the harvest.
- If you choose to Harvest weekly, in the Scheduled Harvesting Day of Week also set the day on which to perform the harvest.
- You can set permissions for all studies and files in the harvested dataverse to either Public or Restricted.
To enable file permissions:
- Use the File Permissions pull-down list to make all study files in the harvested dataverse either Public or Restricted.
- If you choose to make files Restricted, use the Subset Permissions pull-down list to make subsetting of studies in the harvested dataverse either Public or Restricted.
- To enable specific users access to Restricted studies, enter a username in the field Allowed Users, if Files are Restricted, and then click the Add button.
To remove access from a user, click the Remove User button beside that user's name in the Allowed Users field.
- To enable specific user groups access to Retricted studies, enter a group name in the field Allowed Groups, if Files are Restricted, and then click Add button.
To remove access from a group, click the Remove Group button beside that group's name in the Allowed Groups field.
- Click Save or Cancel.
If your save succeeds, the message Update Successful! is displayed.
Click Network Options to return to the Network Admin Options page.
Note: Remember to release your harvesting dataverse to the public. See the Dataverse Admins Guide for information about releasing a dataverse.
Create a New Nesstar Harvesting Dataverse
To create a dataverse that harvests data from a Nesstar server:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Scroll to the Dataverses, Harvesting, Exporting and OAI Sets options, and then click Create a New Harvesting Dataverse.
You see the Harvest Dataverse page.
- In the Harvest Type field, click the radio button for the Nesstar Server option.
- Enter a Name for the dataverse, which is displayed on the Network homepage.
- Enter an Alias, which is the short name for the dataverse used to build the site's URL.
This field is case sensitive.
- Enter the Server URL for the Nesstar network server from which you choose to harvest data, and then click the Validate button.
If the server is valid, additional Harvesting fields are displayed for further configuration. If the server is not valid, the error message Please enter a valid url is displayed. Correct the server name, and then click Validate again.
- Use the Harvesting Format pull-down list to select the XML format to use in harvesting from that server.
The value DDI is available at this time.
- Use the Handle Registration pull-down list to select whether to register with HANDLE.NET any harvested studies that have these identifiers on the server from which you harvest them.
- You can set permissions for all studies and files in the harvested dataverse to either Public or Restricted.
To enable file permissions:
- Use the File Permissions pull-down list to make all study files in the harvested dataverse either Public or Restricted.
- If you choose to make files Restricted, use the Subset Permissions pull-down list to make subsetting of studies in the harvested dataverse either Public or Restricted.
- To enable specific users access to Restricted studies, enter a username in the field Allowed Users, if Files are Restricted, and then click the Add button.
To remove access from a user, click the Remove User button beside that user's name in the Allowed Users field.
- To enable specific user groups access to Retricted studies, enter a group name in the field Allowed Groups, if Files are Restricted, and then click Add button.
To remove access from a group, click the Remove Group button beside that group's name in the Allowed Groups field.
- Click Save or Cancel.
If your save succeeds, the message Update Successful! is displayed.
Click Network Options to return to the Network Admin Options page.
Note: Remember to release your harvesting dataverse to the public. See the Dataverse Admins Guide for information about releasing a dataverse.
Manage Dataverses
You can edit and remove both standard and harvesting dataverses.
For harvesting dataverses, you can:
- Define harvesting schedule.
- Schedule harvesting.
- Run harvester manually.
See the following topics for detailed information:
Edit Dataverse Setup
To edit options for a dataverse:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverses.
You see the Manage Dataverses page.
- Click the name of the dataverse for which you choose to manage options.
You see the My Options page for the dataverse that you selected.
For information about the setup of standard dataverses, see Create a New Dataverse.
For information about the setup of harvesting dataverses, see Create a New Harvesting Dataverse.
Define Harvesting Schedule
Use the Status column in the Harvest Dataverse list to access harvesting schedules as follows:
- Navigate to the Network homepage, and click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Scroll to the Dataverses, Harvesting, Exporting, and OAI Sets options, and then click Manage Dataverses.
You see the Manage Dataverses page.
- If no schedule is set up, the message
Harvesting Schedule Not Defined is displayed in the row for that dataverse.
To set up a harvesting schedule, click the Define Harvesting Schedule link.
You see the Harvest Dataverse page, with values for the current configuration.
- Click the Scheduled Harvesting? check box to enable the schedule.
- Set up the following fields to enable the schedule. See Create a New Harvesting Dataverse for information about these fields:
- Scheduled Harvesting Period - Select Harvest daily or Harvest weekly.
- Scheudled Harvesting Hour of Day - Set the time of day at which to perform the harvest.
- Scheduled Harvesting Day of Week - For a weekly harvest, also set the day on which to perform the harvest.
- Click Save to save the schedule, or click Cancel to loose the setup.
Schedule Harvesting
Use the Status column in the Harvest Dataverse list to enable or disable scheduled harvesting as follows:
- Navigate to the Network homepage, and click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Scroll to the Dataverses, Harvesting, Exporting, and OAI Sets options, and then click Manage Dataverses.
You see the Manage Dataverses page.
- If a schedule is set up but is not active, the message
Not Scheduled is displayed in the row for that dataverse. A Schedule Haravesting button appears beside the message.
If a schedule is set up and is active, the message Scheduled is displayed, and an Unschedule Haravesting button appears.
To enable harvesting on the configured schedule, click the Schedule Harvesting button.
To disable harvesting on the configured scheduled, click the Unshcedule Harvesting button.
Run Harvester Manually
To harvest a dataverse manually:
- Navigate to the Network homepage, and click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Scroll to the Dataverses, Harvesting, Exporting, and OAI Sets options, and then click Manage Dataverses.
You see the Manage Dataverses page.
- Click the Run Harvester Now button in the row corresponding to the dataverse you choose to harvest.
The page changes to display Harvesting Currently Running in place of the Run Harvester Now button. All options for that dataverse are disabled until the harvesting activity is complete, or until you toggle the Schedule/Unschedule Harvesting button.
Remove Dataverses
To remove a dataverse from the Network:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverses.
You see the Manage Dataverses page.
- Locate the entry for the dataverse that you choose to remove, and then click the Remove link in that row of the list.
You see the Deleting a Dataverse page.
- To confirm the remove action, click the Delete button. Or click the Cancel button to keep the dataverse in the Network.
If your delete was successful, you see a Delete Successful page.
Manage Dataverse Groups
You can organize dataverses into groups, to structure the Network homepage and help users to find a dataverse more easily. Create groups of dataverses that have common entities, such as subjects, authors, or dates. This is similar to creating collections within a dataverse. On the Network homepage, a dataverse group name is displayed in a rectangular gray box, and the dataverses in the group are arranged alphabetically under the name.
When you create the first new dataverse group in the Network, then all dataverses become members of a default dataverse group called Other. You can add dataverses to new groups, which moves them from the Other group. A dataverse can belong to more than one group, but use that organization only if it is useful.
You can do the following with dataverse groups:
Add Dataverse Group
To create a dataverse group:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverse Groups.
You see the Dataverse Groups page.
- Click the Add Group link at the botton of the group list.
You see the Dataverse Group page.
- Enter a Name for the group.
- Enter a Description for the group.
- To add a dataverse to this group, click the name of a dataverse that you choose to add in the All Dataverses box, and then click Add. Hold down the Ctrl key to select more than one dataverse, and then click Add to add them all to the group. Or, double-click the dataverse name in the All Dataverses box.
You see the dataverses that you added in the Dataverses in this Group box.
To remove dataverses from this group, click the dataverse name in the Dataverses in this Group box, and then click Remove. Hold down the Ctrl key to select more than one dataverse at a time to remove from them from the group. Or, double-click the name in the Dataverses in this Group box.
- When the dataverse group is set up, click the Save button to save your changes.
You see the Dataverse Groups page, and see a message that your update was successful. On the Network homepage, the group name is displayed in a rectangular gray box, and the dataverses in the group are arranged alphabetically under the name.
Edit Dataverse Group Setup
To edit the setup or name of a dataverse group:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverse Groups.
You see the Dataverse Groups page.
- In the list of groups, click the name of the group that you choose to edit.
You see the Dataverse Group page.
- Edit the name or description of the group, or change the members.
To add a new dataverse to the group, click the dataverse name in the All Dataverses field, and then click Add. To remove a dataverse from the group, click the dataverse name in the Dataverses in this Group field, and then click Remove.
- Click the Save button to save your changes.
- Navigate to the homepage.
The group changes to reflect your new setup.
Change Dataverse Group Order
When you change the order in which dataverse groups are displayed on the Network homepage, you edit the order one time and save your changes. If you try to edit the order a second time without navigating through the Manage Dataverse Groups menu option, your changes have no effect.
To change the order in which dataverse groups are displayed on the Network homepage:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverse Groups.
You see the Dataverse Groups page.
- In the list of groups, change the Display Order value higher to move the group lower on the homepage. Change the value lower to move the group higher on the homepage.
If you change a value in the middle of the list, the order values after that entry change automatically to follow the new value sequentially.
- Click the Save button to save your changes.
- Navigate to the homepage.
The order of groups listed on the Dataverse Groups page changes to reflect your new order.
Change Number of DVs Displayed per Group Page
Within a dataverse group, the member dataverses are displayed in four columns. You can modify the number of dataverses in a group that are displayed on a page. You also can define for all groups a default number of dataverses to display on one page.
If you set the Display Number to a value less than the number of dataverses in that group, Next and Previous links are added to the listing to support paging through the contents of the group.
To edit the number of dataverses that are displayed within a dataverse group page:
- Navigate to the Network homepage and click the Network Options link.
You see the Network Options page.
- Under Dataverses, Harvesting, Exporting and OAI Sets, click Manage Dataverse Groups.
You see the Dataverse Groups page.
- To set the default number of dataverses to display per page for all groups, edit the standalone field contained in the text of item 1.
This field is preceeded by the text Number of dataverses to display per group, per page.
- To modify the default value of dataverses to display per page for a specific group, edit the Display Number field for that group's entry.
The individual group's Display Number setting overrides for that group only the default value.
- Click Save to save your changes.
The page setup for each group takes effect on the Network homepage.
Delete Dataverse Group
If you delete a dataverse group, any dataverse that is a member of that group and is not a member of another group is moved to the default Other group.
To delete a dataverse group:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Dataverses, Harvesting, Exporting and OAI Sets, and then click Manage Dataverse Groups.
You see the Dataverse Groups page.
- In the list of group, click the Delete check box in the row of the group that you choose to delete.
- Click the Save button to save your changes.
The entry for that dataverse group is removed from the list of groups, and the member dataverses return to the default group, Other.
Schedule Study Exports
You can schedule how often studies in your Network are exported into XML that uses DDI (study and variable metadata) and Dublin Core (study metadata only) formats. These export files are used by the Network's OAI server and for the preservation and sharing of your data. You also can edit an existing export schedule.
To set up an OAI export schedule for studies in your Network:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Click Schedule Study Exports.
You see the Study Export Schedule page.
- Use the Export Period pull-down list to select whether to export your Network's metatdata on a daily or weekly basis.
- In the Export Hour of Day field, set the time of day at which to perform the export, based on a 24-hour clock.
Enter an integer between 0 (midnight) and 23 (11 PM).
- In the Export Day of Week field, set the day on which to perform the export. Enter an integer between 1 (Sunday) through 7 (Saturday).
- Click Save to save the schedule, or click Cancel to lose your entries.
If your save succeeds, you see the message Update Successful!
Click Network Options to return to the Network Admin Options page.
To edit an existing export schedule, navigate to the Schedule Study Export option and modify the current configuration on that page.
Manage OAI Harvesting Sets
You can create a new set to be used by the OAI server that comes with your Network. Another DVN, or any other remote site, then can harvest the sets that you define here. If you do not define sets to be harvested, the default OAI call (http://localhost/dvn/OAIHandler) harvests the contents of your entire Network.
Read these topics for detailed information about how to manage OAI harvesting sets:
Create a New OAI Set
To create a set for harvesting of your Network's studies from other OAI clients:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Click Manage OAI Harvesting Sets.
You see the OAI Sets defined in [Your] Dataverse Network page.
- Click the Create a New Set link at the top of the set list.
You see the Edit OAI Set page.
- Enter a Set Name to be displayed when a harvesting OAI client calls your Network's OAI server to harvest from your Network.
- Enter a Set Spec value to use as a unique Identifier for this set.
This value is the token passed from OAI server to client during harvesting.
- Enter a Query Definition from which to create the set.
This query uses the same syntax as query collections, and is based on the Lucene search engine. See List of Metadata for information about query terms. Refer to the Lucene website for infromation about query syntax.
- If you choose, enter a description about the OAI set to help define its contents.
- Click Save to save your settings, or click Cancel to lose them.
You see the OAI Sets defined in [Your] Dataverse Network page, with your set listed.
Edit an OAI Set
To edit an existing OAI set:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Click Manage OAI Harvesting Sets.
You see the OAI Sets defined in [Your] Dataverse Network page.
- Click the set name in the list for the set that you choose to edit.
You see the Edit OAI Set page, containing the current set definition.
- Edit the values to change the set definition.
- Click Save to save your changes.
You see the OAI Sets defined in [Your] Dataverse Network page again.
Delete an OAI Set
You can delete a set from your Network export at any time.
Note: There is no confirmation step when you delete an OAI set. Be sure that you choose the correct set to delete before you start this action.
To delete an OAI set from your Network export:
- Navigate to the Network homepage, and then click Network Options.
You see the [Your] Dataverse Network Admin Options page.
- Click Manage OAI Harvesting Sets.
You see the OAI Sets defined in [Your] Dataverse Network page.
- Click the Remove link in the row of the set that you choose to delete.
Note: There is no confirmation step when you delete an OAI set.
The selected set is removed from your Network export.
Network Settings
When you customize your Network settings, they appear on all pages of the Network by default. Dataverse Admins then can set up individual layouts, descriptions, and contact addresses to appear on their own dataverse pages.
You can customize the following Network settings:
Edit Name
The name of your Dataverse Network installation is displayed at the top of the Network homepage, and as a link at the top of each dataverse homepage in your Network.
To customize the name of your Network:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Settings, and then click Edit Name.
You see the Edit Network Name page.
- Edit the name of your Network.
Enter a descriptive title for your Network. There are no naming restrictions, but it appears in the heading of every dataverse in your Network, so a short name works best.
- Click Save to keep your changes, or click Cancel to lose your changes.
The name of your Network is displayed on the Network pages, and as a link at the top of the homepage for all dataverses in your Network.
Edit Layout Branding (Network)
When you install a Network, there is no banner or footer on any page in the Network. You can apply any style to the Network pages, such as that used on your organization's website. You can use plain text, HTML, JavaScript, and style tags to define your custom banner and footer. If your website has such elements as a navigation menu or images, you can add them to your Network pages.
To customize the layout branding of your Network:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Settings, and then click Edit Layout Branding.
You see the Edit Network Layout Branding page.
- In the Custom Banner field, enter your Network banner.
See Layout Branding Tips for guidelines.
- In the Footer field, enter your footer.
See Layout Branding Tips for guidelines.
- Click Save to keep your changes, or click Cancel to lose your changes.
The banner and footer are displayed on the Network pages.
If a dataverse is set up with a custom banner or footer, that customization is displayed when you navigate to that dataverse.
Edit Description (Network)
By default your Network homepage has the following description: There are no network announcements. You can edit that text to describe or announce such things as new Network features, new dataverses, or maintenance activities. You also can disable the description to not display on the homepage.
To disable or edit the content of the Network description:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Settings, and then click Edit Description.
You see the Network Homepage Description page.
- To disable any description on the Network homepage, remove the check from the Enable Description in Homepage option.
To enable the description on the homepage, check this option.
- Enter your text in the field provided.
You can add to or remove existing announcements at any time.
Note: A light blue background in any form field indicates HTML, JavaScript, and style tags are permitted. The html and body element types are not allowed.
- Click Save to keep your changes, or click Cancel to lose your changes.
The Network homepage description is displayed at the right side of the Network page.
If a dataverse is set up with a description, that customization is displayed when you navigate to that dataverse.
Manage E-Mail Notifications (Network)
On the main menu of your Network pages is a Contact Us link. By default the e-mail address set up for all contacts and requests on your Network pages is the support address for the Dataverse Network Project, dvn_support@help.hmdc.harvard.edu.
To enter your own e-mail address for your Network contacts and requests:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Settings, and then click Manage E-Mail Notifications.
You see the Edit Contact and Notifications E-Mail Addresses page.
- Enter one or more e-mail addresses in the E-Mail Address field.
Provide the addresses of administrators who you choose to receive notification when contacted from this Network. Any time a user submits a request through your Network, including the Request to create a Dataverse link and the Contact Us page, e-mail is sent to all addresses that you enter in this field.
If a dataverse has a customized contact e-mail set up, requests that originate from within that dataverse are sent to that customized address.
- Click Save to keep your changes, or click Cancel to lose your changes.
Network Terms of Use
At the Network level, you can apply Terms of Use to three levels of activity:
- Any user logging in to the Network
- Any user creating studies or uploading files
- Any user downloading study files
See these topics for detailed information:
Edit Terms for Account Creation
You can set up Terms of Use for the Network that require users to acknowledge your terms and click Accept the first time they log in to a new session on the Dataverse Network.
To set general Terms of Use for the Network:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Terms of Use options, and then click Edit Terms for Account Creation.
You see the Edit Network Terms of Use for Account Creation page.
- Click the Enable Terms of Use check box.
- Enter a description of your terms to which visitors must agree when they log in to use the Network.
Note: A light blue background in any form field indicates HTML, JavaScript, and style tags are permitted. The html and body element types are not allowed.
- Click Save Changes to keep your changes, or click Cancel to lose your changes.
Edit Terms for Study Creation (Network)
You can set up Terms of Use for the Network that require users to acknowledge your terms and click Accept before they can contribute to the Network.
To set Terms of Use for creating or uploading to any dataverse in the Network:
- Navigate to the Network homepage.
- Click My Network in the top-right corner, scroll to the Network Terms of Use options, and then click Edit Terms for Study Creation.
You see the Edit Network Terms of Use for Study Creation and Data Deposit page.
- Click the Enable Terms of Use check box.
- Enter a description of your terms to which visitors must agree before they can create a study or upload a file to an existing study.
Note: A light blue background in any form field indicates HTML, JavaScript, and style tags are permitted. The html and body element types are not allowed.
- Click Save Changes to keep your changes, or click Cancel to lose your changes.
Edit Terms for File Download (Network)
You can set up Terms of Use for the Network that require users to acknowledge your terms and click Accept before they can download or subset contents from the Network.
To set Terms of Use for downloading or subsetting contents from any dataverse in the Network:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to the Network Terms of Use options, and then click Edit Terms for File Download.
You see the Edit Network Terms of Use for File Download page.
- Click the Enable Terms of Use check box.
- Enter a description of your terms to which visitors must agree before they can download or analyze any file.
Note: A light blue background in any form field indicates HTML, JavaScript, and style tags are permitted. The html and body element types are not allowed.
- Click Save Changes to keep your changes, or click Cancel to lose your changes.
Network Users, Groups, and Privileges
For all Network and dataverse users, you can do the following:
Manage New Dataverses Invitation
You can invite users to create a dataverse in the Network. When you enable this invitation, the Create your own Dataverse link is displayed in the top-right corner. Users click this link to create a dataverse in the Network.
To invite users to create a dataverse in your Network:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Users, Groups, Privileges, and then click Manage Users Privileges.
You see the Dataverse Creation and Network Users' Privileges page.
- Under Creating a New Dataverse, click the check box for the option Allow users to request to create a new Dataverse when they create an account.
- Click Save Changes to keep your changes, or click Cancel to lose your changes.
On the Network homepage, the Create your own Dataverse link is displayed.
Manage User Privileges
You can add users to the Privileged List and then assign roles to those users. You can grant users the privileges of a Network Admin, who can access and use the Network Options page, or a Dataverse Admin, who can create and manage dataverses and permit other users access to their dataverses.
You also can clear a role, removing any privileges assigned to a user at any time.
Read the following topics for detailed information about these tasks:
Add User to Privileged List
To add a user to the Privilged List and assign a privileged role to that user:
- Log in and navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Users, Groups, Privileges, and then click Manage Users Privileges.
You see the Dataverse Creation and Network Users' Privileges page.
- Under the Network Privileged Users settings enter the username for the selected account in the Enter the Username text field, and then click Add.
The account is added to the Network Priviledged Users list.
- Click the radio button for the role that you choose to assign to this user.
Note:You must assign a Privileged Role to the user before you click Save Changes, or the user is not added to the Privileged Users list. See Assign Roles for details.
- Click Save Changes to save your work. Or click Cancel to lose your changes.
If your save was successful, you see an Update Successful! message.
Assign Roles
To manage creator and Network permissions for user accounts:
- Log in and navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Users, Groups, Privileges, and then click Manage Users Privileges.
You see the Dataverse Creation and Network Users' Privileges page.
- Under the Network Privileged Users settings, locate the username for the selected account to which you choose to assign a role.
- To grant a user Network Admin privileges and give that user permission to use Network Options, click the radio button in front of the Network Admin role.
To grant a user Dataverse Admin privileges and give that user permission to create and manage dataverses, click the radio button in front of the Dataverse Creator role.
- Click Save Changes to save your work. Or click Cancel to lose your changes.
If your save was successful, you see an Update Successful! message.
Clear Roles
To remove permissions for user accounts:
- Log in and navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Users, Groups, Privileges, and then click Manage Users Privileges.
You see the Dataverse Creation and Network Users' Privileges page.
- Under the Network Privileged Users settings, locate the username for the selected account for which you choose to remove a role.
- To remove creator or Network privileges from a user, click the Clear Role button in the row for that account.
- Click Save Changes to save your work. Or click Cancel to lose your changes.
If your save was successful, you see an Update Successful! message.
Add New User Account
To create an account for a new user in your Network:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Add New User Account.
You see the Create a New Account page.
- Complete the account information page.
Enter values in all required fields.
- Click Create Account to save your entries, or click Cancel to lose them.
If your save was successful, you see a message that the account was created.
Manage Users
You can do the following for all user accounts in the Network:
Edit Accounts
To edit an existing user account's information or change the password:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Users.
You see the All Users in [Your] Dataverse Network page.
- In the Username column, click the account name of the user for whom you choose to edit information.
You see the Account for [username] page.
- To edit the account settings, click the Update Account link in the top-right corner.
To change the account password, click the Change Password link.
To exit the account page without making any changes, click the Go To All Users List link.
- If you chose to edit the account or change the password, you see the Edit Dataverse Network Account page.
Enter or change the values on this page.
Note: If you chose to change the password, be sure to enter your Network admin password in the Current Password field.
- Click Save to apply your changes, or click the browser's Back button to leave this page and lose your changes.
If your save was successful, you see a message that the account was updated.
Deactivate Accounts
You can make user's accounts inactive and prohibit them from logging in to the Network. You also can reactive the accounts at any time. It is not possible to delete an account after you set it up.
To deactivate a user account:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Users.
You see the All Users in [Your] Dataverse Network page.
- To change the status of a user account from Active to Inactive, click the Deactivate link in the Status column of that account.
To change the status of a user account from Inactive to Active, click the Activate link in the Status column of that account.
Manage Groups
You can create user groups based on account names or IP addresses.
For example, you can create a user group for an organization and enable affiliate users of that organization's domain to access the Network. Or you can create a group based on some organizational criteria and add user accounts to the group to help you track those accounts collectively.
See the following topics for detailed information about how to manage users and IP groups:
Create a User Group Based on Account Names
To create a user group based on account names:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Groups.
You see the User Groups in [Your] Dataverse Network page.
- Click the Create a New Group link at the top of the group list.
You see the User Group page.
- Enter a Group Name, and enter an easily referenced name in the Friendly Group Name field.
- Click the radio button in front of the Username Group option.
The radio button options are removed, and a Usernames field is displayed for you to add users to the group.
- Enter the username for an account that you choose to add to this group.
- To add another name, click the plus-sign beside a username entry, and then enter the next username in the additional field.
To remove a user from the group, click the minus-sign beside that username.
- When the list of users is complete, click Save to create the group, or click Cancel to lose your edits.
The User Groups in [Your] Dataverse Network page is displayed, and your new group is listed on the page.
Create a User Group Based on IP Addresses
To create a user group based on IP addresses:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Groups.
You see the User Groups in [Your] Dataverse Network page.
- Click the Create a New Group link at the top of the group list.
You see the User Group page.
- Enter a Group Name, and enter an easily referenced name in the Friendly Group Name field.
- Click the radio button in front of the IP User Group option.
The radio button options are removed, and the IP Addresses/Domains field is displayed for you to add users to the group. A check box, labeled This IP group has an affiliate login service, also is displayed at the bottom of the IP Addresses/Domains list.
- Enter the IP address or domain name that you choose to add to this group.
- Click the check box beside the This IP group has an affiliate login service field if the domain has one or more login services associated with it.
New fields are displayed for you to enter the affiliate names and associated URLs for the services.
- Enter the login service name and URL, if appropriate.
- To add another address, click the plus-sign beside an entry in the IP Addresses/Domains field, and then enter the next address in the additional field.
If you enter a login service domain, be sure to enable and enter the login service fields for that domain.
To remove an address or domain from the group, click the minus-sign beside that address.
- When the list of addresses and domains is complete, click Save to create the group, or click Cancel to lose your edits.
The User Groups in [Your] Dataverse Network page is displayed, and your new group is listed on the page.
Edit a User Group
To edit the members of a user group:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Groups.
You see the User Groups in [Your] Dataverse Network page.
- In the group list, click the Group name or Friendly Group Name for the entry that you choose to edit.
You see the User Group page containing the existing group set up.
- To edit the group name or friendly group name, change the existing values in the name fields.
- To add a new user or address, click the plus-sign beside an existing entry, and add the new member in the additional field.
If you enter a login service domain, be sure to enable and enter the login service fields for that domain.
To remove an existing member, click the minus-sign beside the entry that you choose to remove from the group.
- Click Save to save the edited user group, or click Cancel to lose your edits.
You see the User Groups in [Your] Dataverse Network page. If your save was successful, you see a Successful message at the top of the list.
Delete a User Group
When you delete a user group from the Network, any privileges that you assigned to that group are no longer available to members of the group.
Note: There is no confirmation step to prevent you from deleting a user group accidentally. If you click the link to delete a user group, that group is deleted from the Network immediately.
To delete a user group:
- Log in and navigate to the Network homepage.
- Click Network Options, scroll to Network Users, Groups, Privileges, and then click Manage Groups.
You see the User Groups in [Your] Dataverse Network page.
- In the group list, locate the group that you choose to delete, and then click the Delete Group link in the row for that entry.
The deleted user group is removed from the list on the User Groups in [Your] Dataverse Network page.
Advanced Setting for Custom Authentication
Release 1.3 includes an experimental feature that enables Network users to access restricted content on another DVN, or in another location where Basic HTTP authentication is used.
You must arrange with the remote institution to create an account for you, grant that accout the desired access privileges, and pass the credentials (username and password) to you.
To configure privileged access, create an entry in the RemoteAccessAuth database table by using the following command:
INSERT INTO RemoteAccessAuth (id, hostname, authtype, authcred1,
authcred2) VALUES (1, 'REMOTEHOST', 'dvn', 'REMOTEUSER',
'REMOTEPASSWORD');
In this command, authtype is set to dvn. If you are authenticating via HTTP/Basic Auth, set this to httpbasic.
Note: You must grant access to these materials only to authorized users of your DVN, in accordance with the access agreement between you and the provider institution.
Network Utilities
You can troubleshoot and maintain Network functions by using the following options:
- Use Utilities to manage individual file types and file locks, create search indexes, import unique studies, customize exports, and harvest individual studies.
- Access Google Analytics and view web usage statistics.
- View software version and license information for the Network.
See the following topics for details:
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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- 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.
- 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.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Index Utilities arrow.
You see the Index options.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Export Utilities arrow.
You see the Export options.
- 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:
- 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.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Harvest Utilities arrow.
You see the Harvest options.
- Use the DV pull-down list and select the dataverse that owns the study you choose to harvest.
- 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.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the File Utilities arrow.
You see the File options.
- In the Determine File Types field, enter the DVN dataverse ID of the study or studies for which you choose to determine file types.
- 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:
- If you plan to import multiple files or studies, create a master directory to hold all content that you choose to import.
- Create a separate subdirectory for each study that you choose to import.
The directory name is not important.
- 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..
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Import Utilities arrow.
You see the Import options.
- Use the File Format pull-down list and choose the import standard with which your
study.xml files comply.
- Use the Dataverse pull-down list and choose the dataverse to which you choose to import your studies.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Import Utilities arrow.
You see the Import options.
- Use the File Format pull-down list and choose the import standard with which your
study.xml files comply.
- Use the Dataverse pull-down list and choose the dataverse to which you choose to import your studies.
- Click the Choose File button to select the file that you choose to import.
A file browser window opens.
- In the file browser window, navigate to your study file and select that file.
- 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:
- Log in and navigate to the Network Options page.
- Scroll to Network Utilities and click Troublshoot, Maintain Processes.
You see the Dataverse Network Utiities page.
- Click the Delete Utilities arrow.
You see the Delete Utilities field.
- Enter the Study ID of each study that you choose to delete from the network.
- Click Delete Studies.
You are prompted to confirm the Delete action.
- 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.
Manage Web Usage
You can view web usage statistics for the Network by using the Google Analytics utility. Access to this tool is available on the Network Options page in the Network Utilities options.
Note: Access to Google Analytics is optional. If access to this utility is not configured for your Network, in place of the Manage Web Usage menu option is a message stating Google Analytics are not configured for this Network.
To view statistics about the usage Network pages:
- Navigate to the Network homepage.
- Click Network Options in the top-right corner, scroll to Network Utilities, and then click Manage Web Usage.
A new page opens at the Google Analytics web page.
- Log in to Google Analytics by using the Network Admin Google account.
This account is set up during installation of the DVN.
- Use the Google Analytics tools and Help to analyze site usage data for the Network and dataverse URLs.
Note that it takes about 24 hours after installation and set up of this option for tracking data to become available for use.
Dataverse Network Version and License
As the Network admin, you can view version and license information for your Network installation.
To view the Network software details:
- Log in and navigate to the Network homepage.
- Click Network Options and scroll to Network Utilities.
You see the Dataverse Network Version number listed on the current page.
You also see the license information listed below the Network Utilities options.