The following pages and posts are tagged with

TitleTypeExcerpt
Visibility and Access Controls Page Quickstart Samvera uses cancancan to do authorization of many actions. Cancancan generates app/models/ability.rb into your application and then hydra-head’s generator and later Hyrax’s generator each adds a couple of lines so that the class looks like this: class Ability include Hydra::Ability include Hyrax::Ability self.ability_logic...
Working with the Actor Stack Page Content provided by an interview with Mike Giarlo Middleware Definition: Middleware is software that wraps the http request/ response cycle. The Rails middleware (ActionDispatch) handles caching and sets headers, among other things, and the Rails middleware stack is particularly useful because you can very easily customize it. Actors and Actor...
Understanding Participants for Admin Sets Page Impact on Admin Set Access When participants are added to an Admin Set, access to it will be assigned as follows: Managers - edit_access for the Admin Set - able to set Admin Set metadata Depositors - no access levels assigned Viewers - no access levels assigned ...
Admin Sets as Collections FAQ Page Are Admin Sets a type of collection? An Admin Set is a pseudo collection. There is a collection type called Admin Set with predetermined configurations that match the existing behaviors of Admin Sets in Hyrax 2.0 and earlier. For the initial implementation of collection extensions, it was decided to...
Creating User Groups Page Creating Groups of Users: Database-backed Solutions This page demonstrates managing groups with Hyrax Role Management, but there are a few other options available. See: Rolify, Hydra-ldap Setup - Development Note If you need to add administrative users in a production or production-like application, please...
How Do I Build Searches? Page Overview Blacklight generates app/models/search_builder.rb into your application. It defaults to including Blacklight::Solr::SearchBuilderBehavior which are functions that allow Blacklight to talk to Solr (vs another search engine). Samvera generates include Hydra::AccessControlsEnforcement for filtering searches by access (groups & users). Finally Hyrax generates include Hyrax::SearchFilters which overrides...
Coding Style with RuboCop Page Importance of Consistent Coding Styles Coding styles are controlled by RuboCop which performs a number of style related checks on the code. The code may run fine and pass tests while not being style compliant, but compliance with the configured style makes code easier to read and maintain. Travis...
Understanding Collection Sharing Page How to set participants for a collection? Dashboard -> Collections Click Edit collection in action menu beside the collection you want to update Select Sharing tab Search for user/group Set access level to Manager or Depositor or Viewer Click Add button Sharing Roles Manager Managers...
Understanding Collection Type Participants Page NOTE: Only admins can create, edit, and delete collection types. Participants set for a collection type effect how users can interact with collections of this type. How to set participants for a collection type? Dashboard -> Settings -> Collection Types Click Edit beside the collection type you want...
Understanding Collections Types Page Understanding Collection Types It was recognized that not all sites veiw collections the same way. Some may want collections to be unchanged. Others may want some new features. Others may want new features for some kinds of collections and not others. To address this, the concept of a collection...
Prereq: Defining a Controlled Vocabulary Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Creating controlled vocabularies is not required for your app, but we will be using one in this tutorial. So we’ll go ahead...
Understanding the Controller Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. The GenericWorksController class is generated with some default behaviors. It is located at app/controllers/curation_concerns/generic_works_controller.rb # Generated...
Collection Discovery FAQ Page What does it mean for a collection to be discoverable? Collections that are discoverable will have the collection itself included in search results, showing the collection title and summary metadata. Are items of a discoverable collection discoverable? Not necessarily. The collection’s setting for discovery does NOT effect the...
Configuring Discovery Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Configure Blacklight to show the property in search results Optionally, you can configure a property to be shown in the search...
Modifying the Edit Form Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. The inclusion of properties in the new/edit form is controlled by the GenericWorkForm class. The GenericWorkForm class is generated with the basic...
Email Notifications Page Sending Notifications by Email Hyrax uses a gem called mailboxer to send notifications within the application. You can also make it send these notifications by email. Information in this guide is drawn from Messaging with Rails and Mailboxer by Ilya Bodrov-Krukowski. 1. Ensure you can send...
Prereq: Generating a Work Type Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Generating a new work type We’ll begin by generating a new Hyrax work-type for Hyrax for use in the tutorial. We’ll...
Glossary of Terms Page Administrative Set An Administrative Set is a top-level grouping of Works that is managed by a user with administrative privileges, such as reviewing deposited Works before they are made accessible. Unlike Collections, Administrative Sets are not discoverable by searching or browsing the catalog. They are intended to provide repository...
Creating User Groups Page Creating Groups of Users: The Default Setup Samvera ships with a YAML based group management system. Typically this is only used when learning Samvera. To change the groups in the default YAML implementation, you want to edit config/role_map.yml. That file should look something like this: <div...
Configure Hyrax 1 User Polling Notifications Page In lib/hyrax/configuration.rb, there is a method to set the poll interval for notification updates: def notifications_update_poll_interval @notifications_update_poll_interval ||= 30.seconds end You could set this to never (effectively). The setting is referenced in the view partial...
Labels and Help Text Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Labels and help text One of the generated files includes config/locales/generic_work.en.yml in which many of the labels used on forms...
Collection Metadata FAQ Page What metadata is included in collections by default? Core: Hyrax::CoreMetadata Basic: Hyrax::BasicMetadata How can I change the metadata fields used for collections? The Collection class is generated in your app at /app/models/collection.rb when you install Hyrax. This class… includes Hyrax::CollectionBehavior which...
Defining Metadata in the Model Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. The GenericWork class is generated with some default metadata, but we want to update it with our own metadata. The generated version...
Nested Indexing Page Collections In Fedora and Solr In Hyrax, a child (work or collection) is stored as a member of a parent collection. Fedora includes an LDP container “member_of_collections” and a memberOf relationship. The collection relationship is indexed in Solr into “member_of_collection_ids_ssim” and “member_of_collections_ssim” as part of the standard to_solr method....
Collection Nesting FAQ Page What is collection nesting? Collections that have collections as members. Can a collection have collections and works as members? Yes. A collection can have all sub-collections, all works, or a combination of both. How do I setup a collection type that can be nested? Dashboard ->...
Other Metadata Customizations Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Modifying default Hyrax fields Remove a default property from the set of required fields Edit app/forms/generic_work_form.rb (substitute your work-type name...
Understanding Collections in Hyrax Page History Prior to Hyrax 2.1, there was one type of collection referred to as a User Collection. They had the following characteristics. any user could create their own collections collections could be shared for edit or read access with other users collections could be discoverable if visibility is...
Modifying the Show Page Page This tutorial assumes that you generated a work type name GenericWork. If you used a different name, substitute that name for all occurrences of GenericWork and generic_work. Default properties for the show page By default, the new properties will NOT be displayed on the show page for works...
How to Enable and Disable Features Page Some features in Hyrax can be flipped on and off from either the Administrative Dashboard, or via a YAML configuration file at `config/features.yml`. This .yml file doesn't ship with Hyrax but can easily be created. ``` ruby assign_admin_set: enabled: false proxy_deposit: enabled: false ``` For a list of flipper features...
Troubleshooting RIIIF Page # Troubleshooting RIIIF [RIIIF](https://github.com/curationexperts/riiif) is a gem for installing a simple [IIIF](http://iiif.io/) server into your rails application. Hyrax 2.1 ships with it, but it can be used in any rails application. This guide is for troubleshooting your installation if it isn't working as expected. This guide assumes you have installed...
What Happens When I Deposit Something? Page 1. I'm on the form to create a new work and I click the `Save` button. 1. The data is submitted to the controller for the correct work type. This controller was generated when you did `bin/rails generate hyrax:work `. For example the `app/controllers/hyrax/generic_works_controller.rb` if you generated a work type...
What Happens When I Deposit Something? Page 1. I'm on the form to create a new work and I click the `Save` button. 1. The data is submitted to the controller for the correct work type. This controller was generated when you did `bin/rails generate hyrax:work `. For example the `app/controllers/hyrax/generic_works_controller.rb` if you generated a work type...
Workflow and Mediated Deposit in Hyrax 1.x Page Note: This page borrows heavily, and hopes to update, the information contained on [the Sufia Mediated Deposit page](https://github.com/samvera/sufia/wiki/Mediated-Deposit-Workflow). ## Why mediated deposit? In the Samvera community, there are many people who would like to be able to ingest an item and make sure it doesn't go live until the item...