Managing Datasets

Introduction
A dataset is a set of data records (or a set of entities in Drupal parlance) that define access permissions to the data it indexes. Every time you create, read, update or delete an entity, you are creating it, reading it, updating it or deleting it from a dataset where you have the CRUD permissions to perform these actions.

This section shows you how you can manage the datasets on Drupal.

Creating a dataset
There are two ways to create a dataset: This section shows you how these two methods can be used on Drupal.
 * 1) Importing a dataset using a file where it got serialized
 * 2) Creating a new, empty, dataset

Creating a new empty dataset
Click on the top  menu item. Then, you have to click the.

To create a new empty dataset, you have to click the  link from the   tab. Then you have to specify some important information to create that new dataset: Then once you are done, click the  button to create the new dataset. Once you created this new empty dataset, it will be created in the OSF Web Services endpoint you selected. It will also be automatically exposed in Drupal. However, it will be completely empty.
 * This is the title of the dataset that you will use in the OSF instance, and locally on Drupal
 * This is the URI that you want to use to identify this new dataset
 * This is the OSF Web Services endpoint where you want to create that new dataset. Note that this list of endpoints come from the list of registered OSF Web Services endpoints
 * This is the Drupal Role that will have full CRUD permissions on that newly created dataset
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module
 * This is the OSF Web Services endpoint where you want to create that new dataset. Note that this list of endpoints come from the list of registered OSF Web Services endpoints
 * This is the Drupal Role that will have full CRUD permissions on that newly created dataset
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module

The next step would probably be to start creating new entities into this dataset.

Exposing a dataset
When you register a new OSF Web Service endpoint to the Drupal instance, you should see appearing a list of new datasets in the list of datasets accessible to that Drupal instance. However, it is not because you registered the new endpoint that all the datasets become automatically usable by Drupal.

What you have to do once you registered a new endpoint, is to  the datasets to Drupal. Once a dataset is exposed to Drupal, it then become available to all the OSF for Drupal modules.

To expose a dataset to Drupal, you first have to click on the top  menu item. Then, you have to click the. Then you will get to the page that list all the exposed/unexposed datasets coming from all the registered endpoints. A dataset that is available on a registered endpoint, but that is not exposed, looks like the dataset below: If a dataset is available, you will see " " in front of its title. Then, you have some more information such as its, the  which is  and you also know from which Endpoint this dataset is coming from.

If you want to expose that dataset, you have to click on the  link.

You will get to the page that will ask you to specify some more configuration options for this dataset that you are about to expose to Drupal:
 * This is the name you want to give to this dataset. This name is local to this Drupal instance. It will be used to refer to the dataset within the user interface of this Drupal portal
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module
 * This specifies if you want to have this dataset searchable by the OSF SearchAPI module. If this option is unchecked then the content of this dataset won't participate into the seaches performed by the OSF SearchAPI module

Once you are done, you simply have to click the button to expose the dataset to Drupal.

Now you can see the newly imported dataset in the list of accessible datasets.

Exporting a dataset
Click on the top  menu item. Then, you have to click the.

To export a dataset, look for a dataset to export. Then, click the  at the left of the   link. Once the panel of possible operations extends, click the  link. Then you will be redirected to the OSF Export module. What you have to do is to specify the export options:
 * Specify the format you want to use to export the dataset
 * Select the dataset you want to export using the tool
 * It is not possible to export datasets that have more than 1000 records, in one shot, using this tool. The maximum number of records you can export in one click using this tool is 1000. Here you can specify if you want a smaller number of records per slice
 * If you have more records than the number of records per slice you specified, then you can specify which slice of X number of records you want to export in this operation.
 * It is not possible to export datasets that have more than 1000 records, in one shot, using this tool. The maximum number of records you can export in one click using this tool is 1000. Here you can specify if you want a smaller number of records per slice
 * If you have more records than the number of records per slice you specified, then you can specify which slice of X number of records you want to export in this operation.
 * If you have more records than the number of records per slice you specified, then you can specify which slice of X number of records you want to export in this operation.
 * If you have more records than the number of records per slice you specified, then you can specify which slice of X number of records you want to export in this operation.

Finally click the button to export the data you requested.

Changing permissions of a dataset
This section only focus on changing the permissions of a dataset. You can read more about the dataset permissions on the Manage Permissions page that explains everything related to these dataset permissions.

Click on the top  menu item. Then, you have to click the.

Now to access the page to change the permissions of that dataset, you have to click the  at the left of the   link. Then you have to click on the  link.

To change the permissions of the dataset, you have to check the checkboxes to enable the CRUD permissions for different Drupal Roles.

Finally you have to scroll down that permissions page, and click the button to save the newly configured permissions.