Resource Types and Entities

From OSF Wiki
Jump to: navigation, search

Introduction

Screencast Tutorial

0.jpg

Resource types and entities are Drupal Entities that are created, and managed, by the OSF Entities connector module. They are used to expose dataset contents indexed in a OSF Web Services instance into Drupal. The resource types and entities are available to other Drupal modules via the Entity API.

The OSF Entities module is called a "connector" module because it connects the OSF Web Services endpoints to the internal Drupal Entity API.

This page explains how the OSF Entities module can be used to search and browse for records in a OSF instance and how they can be created, updated, deleted and revisionned from Drupal.

This page is organized in three major sections:

  • How to configure the OSF Entities module
  • How to configure the Bundles and Fields to use in Drupal
  • How to manage resources using OSF Entities

Configuring OSF Entities and Resource Types

Configuring OSF Entities

Screencast Tutorial

0.jpg

Configuring OSF Entities is a process that you have to perform to map the classes and properties used in a remote OSF Web Services instance into internal Drupal bundles and fields. Every classes you want to expose in Drupal will be mapped as a bundle and every properties you want to expose in Drupal will be mapped as a field. Once this process of mapping classes and properties into bundles and fields is done, you will be able to use the OSF Entities module which means that you will be able to manage OSF records content from Drupal. To configure the OSF Entities module, you have to click on the top Configuration menu item. Then, you have to click the Configure OSF for Drupal modules.

OSF for Drupal configurations

Then click the Entities Connector tab. Now you will see all the configuration options.

OSF Entities configuration options

Exposing Ontologies to the Mapping Process

The first configuration step that needs to occur is to select the ontologies that are currently loaded into the OSF Web Services instances and that you want to use in the mapping process.

All the ontologies selected here will be exposed to the mapping process below. This means that all their classes and properties will be searchable in the Select Unused Classes and Select Unused Properties sections.

To access this configuration section, you have to click the Select Ontologies button:

Selecting ontologies

Once you clicked that button, you will be redirected to a new page that will list all the ontologies that are currently loaded in the OSF Web Services instances. The only thing you have to do in this section is to select all the ontologies you want to use in the mapping process by checking the checkboxes at their left.

Then you have to click the Save configuration button to save the configuration settings into Drupal.

OSF Entities select ontologies

Mapping Classes and Properties into Bundles and Fields

This is the crux of the OSF Entities configuration. This section explains how the classes and properties mapping process is working. This is a two step process:

  1. The first step is to select all the classes that you want to expose into Drupal using bundles
  2. The second step is to select all the properties you want to expose into Drupal as field instances of the bundles you created in the previous step

Once this configuration step is completed, you will be able to manipulate the OSF records natively into Drupal using its own internal API and various user interfaces.

To start this mapping process, you have to click the Expose Entities button.

Osf entities configurations expose entities.png

The first step of the process is to select all the classes that you want to expose to Drupal. A OSF Web Services instance is composed of number of datasets that defined hundred of thousands of records and that are defined using tens of classes and properties. However, not all these records and these classes necessarily need to be exposed into a Drupal portal. This is why the initial step is to only select the classes that we really want to expose to the Drupal portal.

All the classes that we will be selecting on this page will create a bundle in Drupal. What that means is that content maintainer will be able to create new records of these types. They will be able to modify existing records of these types, and they will be able to delete records of these types. This means that all the records of these selected classes will be manageable within the Drupal user interface.

This page as two major sections:

  1. Select Used Classes
  2. Select Unused Classes

It is important to understand the distinction between these two sections.

In the Select Used Classes section, what we have there is a list of all the classes that are currently being used to describe record content into the OSF instance. This is a convenient way to say: check these classes, there are a good chance you want to map them since they are currently being used to describe records content into the OSF instance. By selecting classes in this section, you will create a new Drupal bundle for each of them.

Also note that some of the classes are pre-select and disabled (grayed). This means that these classes are always present in Drupal, and that they are core concepts that need to be mapped.

Osf entities used classes.PNG

Then we have the Select Unused Classes section. This section is used to handle a specific usecase: you want to expose a class that is defined in a loaded ontology, however there is currently no record instances using that class in the OSF instance.

The common usecase for that section is that you want to create a new kind of record, in the OSF instance, using the Drupal user interface. Since no records of this type currently exists in the OSF instance, it means that it won't appear in the Select Used Classes section above. It is for that reason that you have to select the class in this section. Just like with the section above, a new bundle will be created from that class.

If you cannot find the class that you are looking for, make sure that you selected the ontology where that class is defined, as explained in the Exposing ontologies to the mapping process section above.


Osf entities expose entities select unused classes.png

Once you are done, you have to click the Next, select properties button which will redirect you to the second page (step) of the mapping process.

Now that you selected the classes you want to map as bundles into Drupal, the next step is to select all the properties you want to map as fields into Drupal. When you create and modify records information in Drupal, you are doing this using conventional HTML forms. Each field of the form is a property and a value that you want to define to describe a specific instance record (a thing). What this property mapping does is to define all the fields that will be presented to the content maintainer in the create/edit forms generated by Drupal.

There is one important thing to know at this point: every field type that will be used for the fields that are created in this process are defined in the ontologies. If you want to know how you can influence the field type selection at this stage, I strongly suggest you to read the Configure Ontologies for Selecting Field Types page.

Here is the list of all supported Field Type and Wiget by OSF Entities:


Field Type Field Type Machine Name Field Type Named Individual
Date date http://purl.org/ontology/drupal#Date
Date (ISO format) datetime http://purl.org/ontology/drupal#DateISO
Date (Unix timestamp) datestamp http://purl.org/ontology/drupal#DateUnixTimestamp
Boolean list_boolean http://purl.org/ontology/drupal#Boolean
Decimal number_decimal http://purl.org/ontology/drupal#Decimal
File file http://purl.org/ontology/drupal#File
Image image http://purl.org/ontology/drupal#Image
Float number_float http://purl.org/ontology/drupal#Float
List (Float) list_float http://purl.org/ontology/drupal#ListFloat
List (Integer) list_integer http://purl.org/ontology/drupal#ListInteger
List (Text) list_text http://purl.org/ontology/drupal#ListText
Link link http://purl.org/ontology/drupal#Link
Long text and summary text_with_summary http://purl.org/ontology/drupal#LongTextAndSummary
Long text text_textarea http://purl.org/ontology/drupal#LongText
Text text http://purl.org/ontology/drupal#Text
Geolocation geolocation_latlng http://purl.org/ontology/drupal#Geolocation

When you first get to that page, you will notice that there is a section for each and every classes you selected from the previous classes mapping step. What we are doing in this section is to select the properties to map for each of these classes you selected. What you have to do is to expend each of these section to make sure that you exposed all the properties you wanted to expose.

Just like with the classes mapping section, for each classes section, you have a Used Properties and Select Unused Properties section. The rational is the same. In the Used Properties section, you get the list of all the properties that are currently used to describe a record of that class type in the OSF instance. Then, if you want to expose another property (that is not currently used), then you have to select it from the Select Unused Properties section.

Osf entities expose properties.PNG

Then, when you are done selecting all the properties for all the classes, the last thing you have to do is to click the Expose button. Depending on how many classes and properties you are mapping, it may take a few minutes to finish loading this process. You shouldn't close your browser's page, nor refresh the page while the page is loading after you click the Expose button.

Osf entities expose classes properties.PNG

Once the next page loaded, you are done with the core of the OSF Entities configuration steps. You will now endup with a series of bundles and fields internally in Drupal. In the following sections we will see the impact of this exposition process, and what this enables you do to.

This process of exposing classes and properties into Drupal is not static in time. In the future, you will most than likely will have to start manipulating new kind of classes, or to start using new kind of properties for some of the bundles. What you will have to do is to do this process again to select more classes and properties to expose into Drupal.

Other Entities Settings

There is one other feature that can be configured into OSF Entities. This feature call Enable autocompletion fields for datatype properties values is used when you are creating new records, or when you are modifying existing ones. If you enable this configuration option, then it means that when you will create/edit a record using the Drupal user interface, all the fields (properties) that have strings has values will have an autocompletion behavior. What this autocompletion behavior will do is to list all the textual values currently defined in the OSF instance that are referenced by these properties by records of that same type.

This option is disabled by default but can be really powerful depending on the requirements.

Struct entities configurations auto completion 2.png

Configuring OSF Resource Types

Once you clicked the Expose button in the previous classes and properties exposing process above, you then create a series of Drupal Bundles, Fields and Fields Instances. These three things are what will enable you to generate the HTML forms that will be used to create new records and edit existing ones.

What will be discussed in this section is not different to what you do with the Content Types bundles. These are just different kinds of bundles, used to manipulate records information in Drupal but directly into the OSF instance.

Create/Modify/Delete Resource Type Bundles and Fields

To see all the Resource Types bundles you created above, you have to click the Structure top menu item. This will show you the complete list of all the existing type of Drupal bundles. As you can see, there is a Resource Types item that you can click to see the complete list of Resource Types bundles that are currently existing on your Drupal portal.

Osf entities structure.png

Once you clicked on that link, you will see a list of the existing bundles. There are multiple things you can do from that page:

  • You can edit the information about one of the bundle
  • You can manage the fields associated with one of the bundle
  • You can manage the display of the fields (how they get displayed in the generated HTML forms) of one of the bundle
  • You can re-organize the existing resource type (this redirect you to the first step of the exposition process as outlined above)
  • You can add a new resource type (this is a utility user interface that let you create a new class in an ontology, and then to create a bundle for it)
Osf entities structure resource types.png

Edit a Resource Type Bundle

If you click on the Edit operation on the page that list all the existing bundles, you will get to that bundle edition page. What you can do here is to change the display name of that bundle (its Label). You can also add a description.

However, the most important option in this edition page is the Ignore synchronized resource type option. If this option is checked, it means that the exposed class won't be usable to the end user (for editing content of that type, to create new content of that type, etc). However, it will be usable internally by Drupal. If a bundle has this option checked, then you will see Ignored - in front of its label in the list of all the bundles (as you can notice in the screenshot above).

Osf entities structure resource types edit.png

Manage the Fields of a Resource Type Bundle

If you click the Manage fields link from the page that lists all the bundles, then you will get to this section that enable you to edit the fields currently defined for the bundle. What you can do here is to change the field, remove it, change its label, etc. by clicking the different operations.

Osf entities manage fields.PNG
Configuring Field Widgets

Once all the bundles and fields have been created in Drupal using the OSF Entities mapping process, you can continue the configuration process of these fields by specifying the field widgets you want to use for each of them, and then to configure each of these field widgets such that they behave the way you want them to behave.

The first thing to do is to click the field widget's name that appears in the WIDGET column of the list of fields in the bundle you are editing.

Osf entities manage fields widgets.PNG

Then you will be prompted with a list of field widgets that you can use for this field type. Select the one you want to use and save your configuration option. Then Drupal will prompt you with a series of additional configurations that you will be able to configure for that given field widget.

Here is the list of all the field widgets, by field type, that are supported by OSF Entities:


Field Type Field Widget Widget Example
Text Text Field
Img 5.PNG
OSF Entity Reference
Img 20.PNG
OSF Concept Reference (Tagging)
Img 19.PNG
Long text and summary Text area with a summary
Img 17.PNG
Long text Text area (multiple rows)
Img 19.PNG
List (text) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
List (integer) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
List (float) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
Link Link
Img 14.PNG
Integer Text field
Img 5.PNG
Float Text field
Img 5.PNG
Image Image
Img 13.PNG
File File
Img 10.PNG
Entity Reference Select list
Img 7.PNG
Check boxes/radio buttons
Img 6.PNG
Autocomplete
Img 8.PNG
Autocomplete (Tags style)
Img 8.PNG
Decimal Text field
Img 5.PNG
Date (Unix timestamp) Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Date (ISO format) Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Date Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Boolean Check boxes/radio buttons
Img 2.PNG
Single on/off checkbox
Img 1.PNG
Geolocation Latitude/Longitude
Img 11.PNG
Google Map
Img 12.PNG

Manage the Display of Fields for a Resource Type Bundle

If you click the Manage display link from the page that lists all the bundles, then you will get to this section that let you re-order and modify the display of these fields. As you will see in the sections below, all the fields of a bundle will be displayed as an HTML form that the content maintainer will use to create and edit records data in the OSF instance. What you can do is to re-order the fields in that list such that you get the more important fields at the top of the form, etc.

Osf entities manage fields display.PNG

What you can additionally do is to hide some of the fields. What that means that is these fields will still be taken into account, but they won't be displayed in the forms that will be generated by Drupal. To be able to hide such a field, you have to drag-and-drop it into the Hidden section as shown below:

Osf entities manage fields display hidden.PNG

Once you are done modifying the display of the fields, you simply have to click the Save button.

Add a New Resource Type Bundle

At any time you can click the + Add new resource type link to create a new Resource Type. This will redirect you to this form that let you create a new Resource Type.

Osf entities manage create new resource type.PNG

As you know, all the resource type bundles are referring to an ontology class existing in the loaded ontologies in a OSF instance. What this feature does is to bypass the classes mapping workflow as described above to directly create a new class in a selected ontology, and then to create a new bundle for it. What you have to specify is:

  • Name
    • The name of the new Resource Type to create. This name will be used to create the URI of the class in the selected ontology
  • Ontology
    • The ontology where you want to create the new class that will be mapped to the new resource type
  • Description
    • The optional description of that resource type

Once you click the Save resource type button, two things will happen:

  1. A new class will be created in the selected ontology
  2. A new bundle will be created, and referring to that new class
The new class will be created under the Thing top concept of the selected ontology. If you want to re-organize the newly created class elsewhere in the ontologies structure, you should use the OSF Ontology module to position it elsewhere in your ontology.

Using OSF Entities and Resource Types

This section will show you all the features that are enabled on the OSF Entities is configured in a Drupal instance.

Browsing and Searching Resources

Screencast Tutorial

0.jpg

One of the core feature that OSF Entities provide, is a tool that the content authors can use to search, browse and filter all the content they have access to from a OSF instance. What that means is that if a particular user only has access to the datasets X, Y and Z, then he will only see the results from these datasets when he will be using this search, browse and filter tool. Another user that has access to the datasets A, B and C will only see the results from these datasets as well. This means that this same user interface can be used to navigate information from the data sources a user has access to.

To access this section, you have to click the Resource top menu item.

Osf entities resource tab.png

Once you clicked that menu item, you will be redirected to a page that will let you search, browse and filter the information you have access to. The first operation to perform can be a simple search query for the keyword 'iowa'. Once you clicked the Search button, you will get a list of results that match this keyword.

If you want to remove the search keyword, and if you want to re-perform the search without that keyword, you you simply have to click the Remove button.

Osf entities resources search.PNG

Once you started to search for specific records, you can additionally apply different filtering criterias to the search query. There are currently two filtering criterias that you can use to filter your data:

  1. The dataset provenance of the records
  2. The type of the records

If you want to search exclusively within the content of a dataset, then what you will have to do is to select that dataset and click the Filter button. Once you clicked that button, a search will be re-issued by the system, and you will be presented all the records, from that dataset, that match the search keywords.

Then if you want to search only within a specific kind of records, then you can select that type, and click the Refine button. At that point, you will be performing a search that match the search keywords, for the records indexed in that dataset and that use that type.

At any time you can click the Reset button to remove all the filters applied to that search.

Osf entities resources search filter.PNG

Another option you have is to select the columns you want to display on that page. Not all columns are necessary for everybody. By checking the columns and by clicking the Reorganize button, you will be able to show/hide different columns. These settings will persist over time, for the user that you are logged with.

Osf entities resources search columns.PNG

Once you did perform a search, you will get a series of matching records from the OSF instance. Depending on the columns you have selected, you will see:

  1. The preferred label of the record
  2. The URI of the record (hidden by default)
  3. The type of the record
  4. The dataset provenance of the record
  5. The status of the record
  6. Different operations you can perform on the record

When you use this searching tool, you are searching all the records you have access to in the OSF instance. However, it is not necessarily all the record types that have been exposed as bundle in Drupal. This is where the STATUS columns comes into play. You do have two status possible in that column:

  1. Exposed
  2. Available

If the status is Exposed, then it means that the record that is returned to you is currently exposed in Drupal. That means that there exists a bundle for that type of record.

If the status is Available, then it means that the record is accessible to you, but that there is no bundle that expose that type of record to Drupal. This means that this class didn't get exposed to Drupal and so that no bundle exists for that kind of record. If a record is marked as Available, then you will have an option to start exposing that class into Drupal.

The you have 4 different kind of operations possible:

  1. Edit
  2. Delete
  3. Configure dataset for editing
  4. Expose

If the edit link is clicked, then you will be redirected to a page where you will be able to edit all the information related to that record.

If the delete link is clicked, then you will be redirected to a page that ask you if you really want to delete that record.

If the configure dataset for editing link is displayed for a record, that means that this record is indexed in a dataset that you have access to, but that is not currently configured in the OSF for Drupal module. What that means is that this record is no available to any other OSF for Drupal tool since it is not (yet) configured in OSF Configure. Once it get configured in OSF Configure, the available options will change accordingly.

If the expose link is displayed for a record, that means that the record is available, but there is no bundle for its type. If you click on that link, you will be redirected to expose that type class as a bundle in Drupal.

Finally, you have a final filtering option that is available to you check is called Show available records that are not currently exposed in the portal. If this option is checked, and if the Show available button is clicked, then it means that you will start seeing records that have a status of available. By default, these available records are shown. However, you can hide them by using that option.

Osf entities resources search available.PNG

Creating New Resources

One of the core reason why we want the OSF Entities module enabled and configured is to be able to create new records and to index them directly into the OSF instance. That means that the new record would become available to other portals that would use the same OSF instance.

To create a new record, you have to click the top Resource menu item. Then you have to click the + Add resource link.

Osf entities add record.png

Once you clicked that link, you will be redirected to a page that will display all the type of Resource Type records that you can create.

If you edited the created bundles, and if you clicked the option Ignore synchronized resource type then you won't see these bundles appearing in that list.


The next step is to click on one of these link to start creating a new record of these types.

Osf new resource.PNG

Once you clicked on one of these links, then you will be redirected to a page where you will see an HTML form that you will be able to use to populate information about that new record you are about to create. This form is generated by Drupal depending on the way to configured the bundle and its fields in the Configuring Resource Type Bundles and Fields section above.

There are minimally three (3) required fields in that form:

  1. Unique identifier
  2. Dataset
  3. Preferred label

The first thing to determine is what is the unique identifier of the new record you are creating. This unique identifier is a string that as alpha numeric characters, underscores "_", dot "." or dash "-" characters. The unique identifier can be anything. However it is normally related to the preferred label you will choose to define. An example of unique identifier could be "iowa_public_school_a".

The the second thing you have to determine is where the record should be indexed, in which dataset. The user interface will present you a drop-down list of all the datasets where you can create new records.

Finally you will have to write the preferred label of that record.

Once you defined your unique identifier, and once you selected your dataset, you will be defining the complete unique identifier (URI) of the record you are about to create.

Let's say that you defined the unique identifier to be iowa_public_school_a. Then you choose the dataset "Iowa Public Schools". This dataset has the URI http://localhost/datasets/iowa_public_schools/.

What the system will do is to create a final unique identifier by concatenating these two values. This means that the real URI of the record you creating will be:

http://localhost/datasets/iowa_public_schools/iowa_public_school_a


Osf creating new resource.PNG

Finally what you can do is to add values for all the other fields displayed in that HTML form.

Modifying and Revising Resources

Another of the core reason why we want the OSF Entities module enabled and configured is to be able to modify and revision existing records directly into the OSF instance. That means that the changes to a record will become available to other portals that would use the same OSF instance.

If you click on one of the record displayed by the search tool discussed above, you will get to that page below. What this page does is to show you a (generic) view of that record which list all the properties and values that define that record. As you can notice, there are a few tabs at the top of that page. The one that currently interest us is the Edit tab.

Osf entity view.PNG

When you click the Edit tab, you get redirected to a page similar to the one that we saw when we were creating a new record. The main difference is that the fields are pre-populated with the current values that describe that record. The purpose of this user interface is that it let you:

  1. Modify existing information
  2. Remove existing information
  3. Add new information to what already exists for that record
Osf entity edit.PNG

In these forms, there are two different type of fields:

  1. The fields that reference another record/entity
  2. The fields that have a string as value

The fields that reference other records/entities are using the OSF Entity Reference field widget. You should refer to the Configuring and Using the OSF Entity Reference Field Widget page to know how to configure and use that widget. You will only be able to reference entities that currently exists into the OSF instance. The widget will let you search for the entities you want to reference. Depending how the widget is configured, you will be able to select one or multiple entities. All the selected entities will appear in blue boxes like this:

Img 20.PNG

Then the fields that have a string has value (so, all the fields that doesn't reference to another entity) can use a long list of field widgets. Each of these field widgets are different user interfaces that are used to help the user to specify the right value for a given property/field. Here is the list of all these field widget currently supported by OSF Entities, and a screenshot of each of them:


Field Type Field Widget Widget Example
Text Text Field
Img 5.PNG
OSF Entity Reference
Img 20.PNG
OSF Concept Reference (Tagging)
Img 19.PNG
Long text and summary Text area with a summary
Img 17.PNG
Long text Text area (multiple rows)
Img 19.PNG
List (text) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
List (integer) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
List (float) Select list
Img 16.PNG
Check boxes/radio buttons
Img 15.PNG
Link Link
Img 14.PNG
Integer Text field
Img 5.PNG
Float Text field
Img 5.PNG
Image Image
Img 13.PNG
File File
Img 10.PNG
Entity Reference Select list
Img 7.PNG
Check boxes/radio buttons
Img 6.PNG
Autocomplete
Img 8.PNG
Autocomplete (Tags style)
Img 8.PNG
Decimal Text field
Img 5.PNG
Date (Unix timestamp) Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Date (ISO format) Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Date Text field
Img 3.PNG
Select list
Img 4.PNG
Pop-up calendar
Boolean Check boxes/radio buttons
Img 2.PNG
Single on/off checkbox
Img 1.PNG
Geolocation Latitude/Longitude
Img 11.PNG
Google Map
Img 12.PNG

Finally, before saving a record, you will be asked if you want to moderate the modification you are doing. You have three options:

  1. Modify current resource, no revision, no moderation
    1. If this option is used, then the modifications you did to this record will be directly modified in the OSF instance without creating a revision with the changes. With this option, rollback of the changes is not possible
  2. Create new revision, no moderation
    1. If this option is used, then the modifications you did to this record will be directly modified in the OSF instance, but a new revision record will be create with these changes. With this option, roolback o the changes is possible
  3. Create new revision and moderate
    1. If this option is used, then the modifications you did to this record will not be directly modified in the OSF instance. A new revision will be created with the changes, but the modifications of the record won't be published. These changes will need to be moderated, and then they will eventually be published to the dataset.
Osf entities entity edit revision.png

If you choose one of the two options that create a revision, then you will see appearing a new Revisions tab as shown below.

If you click on that tab, you will be presented a list of revisions that exists for that record. The currently published revision will appear with a yellow background. For each revision, you have three operations:

  1. Visualize the revision by clicking on the date of the revision on the left side of a record line
  2. Publish a revision by clicking the revert link in the Operations column
  3. Delete a revision by clicking the delete link in the Operations column

By visualizing a revision, you see what the record will look like if it would be published.

By publishing a revision, you are in fact re-creating a new revision record, but using this previous status. This means that the published record will become a copy of the revision where you clicked revert.

By deleting a revision, you are simply deleting the revision in the system. This means that you won't be able to rollback the changes you made with that revision.

Osf entities entity edit revision view.png

Another thing you can do with this revisions section, is to compare two revisions. To compare two revisions, you have to click the compare link of one of the revision record. Once you did this, the values of the Compare column will change. Then what you have to do is to click the with link such that you compare the revision you previously selected with that other revision.

Osf entities entity edit revision compare.png

Once you selected the two revisions records that you want to compare, you will be presented a user interface that show you all the modifications that occurred between the two revisions. What you will see in this user interface is:

  • The new properties/values that may have been added on one side or the other
  • All the text, within the values, that may have change (added or removed), one one side or the other
Osf entities entity edit revision compare view.png

Deleting Resources

Another thing you can do with OSF Entities is to delete a record in the OSF instance using the Drupal user interface. What you have to do to delete a record is to:

  • Click the delete link operation in the search user interface as shown above
  • Click the Delete tab when you are viewing a record

Once you did one of these two actions, you will be presented a user interface that ask you if you are really sure to want to remove that record.

When you delete a record, internally, in an OSF instance, it is a soft delete that is performed. What this means is that the record is actually unpublished. However, all the revisions of the record are still existing which means that it could be re-published in the future. However, there is currently no facility in the OSF Entities to detect these records for re-publishing them in the future, this would need to be done by hands directly on the OSF instance. Also, in the future, an option could be presented to use user to know which kind of delete he would like to perform (soft or hard delete).

Osf entities entity delete.png

Exporting Resources

Screencast Tutorial

0.jpg

All and every Resources Entities can be exported. If the permissions are properly configured, an Export tab appears on the individual records pages. By clicking on that tab, you will be redirected to a page that list a series of serialization format that you can use to export the content of that resource page. The supported formats are:

Osf entities entity export.png