Question from the 4Science / Lyrasis webinar

[Bollini, Andrea]

Hi all,

during our last webinar 

The Big Picture: Why Entities are Important for Institutional Repositories and What You Can Do with DSpace, May 30 11:00 AM ET (10:00 AM CT/9:00 AM MT/8:00 AM PT)

we got this question that was not possible to answer live, so I like to provide it here

Q: What exactly do i need in my submission forms . xml to allow author

insertion to use an entity of the person type ?

I have a collection of entities but there are no clear , outright

examples of what exactly needs to be in the xml file (dspace 7.5 already

activated for entities)

One exact example would really help

Thanks

A: To configure entities you essentially need three steps, if I understand correctly you are stuck with the second step. For completeness I describe all the steps

1. define which entities types you want to support and how each one relates to the others. This is done in a "relationship" xml file like https://github.com/DSpace/DSpace/blob/main/dspace/config/entities/openaire4-relationships.xml that is loaded in the system via the initialize-entities script
   [/dspace]/bin/dspace initialize-entities -f [/dspace]/config/entities/openaire4-relationships.xml

if your data model defines new metadata schema and/or element you will need to write down you registry extension, like 

https://github.com/DSpace/DSpace/blob/main/dspace/config/registries/openaire4-types.xml

and load it in the system via

[/dspace]/bin/dspace registry-loader -metadata [/dspace]/config/registries/openaire4-types.xml

2. You need to create collections dedicated to the new defined entities, so at least one for each entity type and assign to each of this collection the appropriate submission configuration.
   This is done in two configuration files:
   - item-submission.xml file you will link the collection to a "named submission form" that is composed of several steps most of them will be dedicated to collect metadata and relationships.
   - For those steps you are going to define the details in the other xml configuration file the submission-forms.xml
   Using the openaire4 data model sample you can find the corresponding submission configuration here 
   - https://github.com/DSpace/DSpace/blob/main/dspace/config/item-submission.xml#L37-L48 (it needs to be uncommented, handle adapted to your installation and the submission name must match the defined data model)
   
   - https://github.com/DSpace/DSpace/blob/main/dspace/config/item-submission.xml#L349-L362 define the steps used to submit a publication according to the openaire data model, where openAIREPublicationPageoneForm https://github.com/DSpace/DSpace/blob/main/dspace/config/item-submission.xml#L353 is the one containing the definition of the relationship among the publication and the person (authors)

   
   

   - the details of the openAIREPublicationPageoneForm configuration are defined here https://github.com/DSpace/DSpace/blob/main/dspace/config/submission-forms.xml#L824 and more specifically this is the fragment that is used to allow to store authors in the publication as normal dc.contributor.author or using related person entities https://github.com/DSpace/DSpace/blob/main/dspace/config/submission-forms.xml#L849-L866

   
   
   3. Last step to use your data model is to define special configuration (if needed) to showcase the inverse relationship in the discovery.xml used for instance to include publication list in the author profile. The configuration and the relation is named in the custom item page component that you can create to visualize your entity, see for instance how it is done to show authored publication in the person page here
   https://github.com/DSpace/dspace-angular/blob/main/src/app/entity-groups/research-entities/item-pages/person/person.component.html#L59-L65
   

The official DSpace documentation explain the above steps with different wording here 

https://wiki.lyrasis.org/display/DSDOC7x/Configurable+Entities

and here tailored to the openaire4 data model

https://wiki.lyrasis.org/display/DSDOC7x/OpenAIRE4+Guidelines+Compliancy

Hope this help,

Andrea

--

Andrea Bollini

Chief Technology and Innovation Officer

4Science, www.4science.com, ISO 9001:2015, CSA Trusted Cloud Provider

Certified Platinum Provider of DSpace, DSpace-CRIS, DSpace-GLAM

4Science USA - 435 Nichols Road Suite 200, Kansas City, MO 64112

4Science Europe - Viale Achille Papa 30, World Join Center Tower, 20149 Milano, Italy

mobile: +39 333 934 1808

linkedin: andreabollini

orcid: 0000-0002-9029-1854