Hyrax Stack Walkthrough - RepoCamp/ohsu2018 GitHub Wiki

This guide assumes you are starting with a template-generated instance of Hyrax.

Goals:

  • Understand the way an item in Hyrax
    • is displayed in the User Interface,
    • is represented in the application Code
    • is stored in Fedora
    • is indexed in Solr

Lesson Setup

  • If you're running in a VM, change to the /vagrant directory
    cd /vagrant
  • Clone this repository and check out the lesson:
    git clone -b walkthrough https://github.com/RepoCamp/ohsu2018.git && cd ohsu2018
  • Update dependencies:
    bundle install
  • Run migrations:
    rails db:migrate
  • Start the development environment servers:
    rails hydra:server

    This launches development instances of Solr, Fedora, and your web application server. You'll leave the servers running in this terminal window for the rest of this lesson. You can check back here to see output from the Rails server.

  • Open a new terminal window -- yes, a second one! -- then login to the VM and change to the ohsu2018 directory
    # in a new terminal window
    vagrant ssh
    cd /vagrant/ohsu2018
  • Create the default Admin Set (an administrative collection -- every work instance deposited must belong to one and only one Admin Set):
    rails hyrax:default_admin_set:create

Steps

  1. Inspect an empty repository You rarely see this in the real world...

  2. Set up a user and create a work using the User Interface

    1. Go to http://localhost:3000, click on the Login link in the upper right-hand corner
    2. If you haven't created a user yet, click the Sign up link just below the login button
    3. Enter your chosen e-mail and password
    4. From your Dashboard, click on the Works link in the left-hand navigation bar
    5. Click on the Add new work button to add a new item to the repository Notice the Requirements section in the SAVE WORK panel
    6. Fill out the fields marked with blue required labels Notice the Requirements section in the SAVE WORK panel
    7. Click on the Files tab
    8. Click on the + Add Files button and select a file to upload NOTE: if you copied files from a thumb-drive, there are sample files to use in your tutorial/vagrant/samples-assets folder Notice the Requirements section in the SAVE WORK panel
    9. Click the checkbox for the deposit agreement and click the SAVE button
    10. Wait a second and take a look at your new Work!

  3. Now that you have something in your repository, let's take a look at it

    • User Interface: go to http://localhost:3000, click on the search icon you should see your new item listed in the results along with a facet list to the left
    • Code: from the Rails console, check Work.count, then Collection.count again you now have 1 work and no collections
    • Fedora: go to http://localhost:8984/rest/dev note the number of new children in this container - can you figure out what any of them are?
    • Solr: go to http://localhost:8983/solr/#/hydra-development check whether the document counts under "Statistics" has changed

  4. Find a work by its identifier Do a search from the user interface and click on your work, you can read the id from the work's URL

Exercises

  1. Add an optional field using the User Interface

    • Verify the change in the Code. HINT use the ID in the url and use it to find the item using the console. You might need to use the .reload method on your work to refresh attributes in memory.
    • Verify the change in Fedora.
    • Verify the change in Solr.

  2. What other fields are available? Does what you see in the User Interface match the code at hyrax/basic_metadata.rb? Also see: https://github.com/no-reply/sufia-profile/blob/master/profile.md

  3. What happens when you add multiple entries for a field?

  4. What happens when you remove all the entries for a field?

  5. Add a second description using the console. HINT you'll need to use the .save method to make changes in memory persist to Solr and Fedora.

    • Verify the change in the User Interface.
    • Verify the change in Fedora.
    • Verify the change in Solr.

  6. Find the access controls in Fedora

    • Change the access control (visibility) using the User Interface
    • What changes in Fedora

  7. Create an empty Collection using the User Interface

    • Verify that Collection.count has changed in the rails console
    • What does the collection look like in Code?
    • What does the collection look like in Fedora?
    • What does the collection look like in Solr?

  8. Add a new Work to your collection using the User Interface

    • What does the Work look like in CODE
    • What does the collection look like now in Code?
    • What does the collection look like now in Fedora?
    • What does the collection look like now in Solr?
    • What does the Work look like in Solr?

  9. Attach and image to an Work using the UI. Then look at FileSets (#file_sets) and Files (#files) in the Rails console (NOTE: the #files method may be called on a FileSet instance)

    1. Find the original file_name
    2. Display the width, height, color_space, profile_name, size, mime_type, fits_version
    3. Inspect the content
    4. Show predicate mappings inherited from Hydra::Works::Characterization::ImageSchema https://github.com/samvera/hydra-works/blob/master/lib/hydra/works/characterization/schema/image_schema.rb