Workflow and Mediated Deposit

Note: This page borrows heavily, and hopes to update, the information contained on the Sufia Mediated Deposit page.

1 Why mediated deposit?
2 What is a workflow?
3 How do I use the mediated deposit workflow that ships with Hyrax?
- 3.1 Via the UI
- 3.2 Programmatically
  - 3.2.1 Make a new AdminSet, tell it to use the one_step_mediated_deposit workflow
  - 3.2.2 Add a user to a workflow
4 How can an application set up workflow programmatically?
5 How do I assign reviewers for a deposited work (e.g. ETDs) without creating lots of AdminSets?
- 5.1 Quick Overview of Workflow
- 5.2 How to Do This
6 How do I set up an app to use a given workflow by default?
7 How do I diagram and configure a new workflow?
8 How do I test that all of this is working correctly?

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 and its metadata have been thoroughly reviewed. This is where mediated deposit comes in. In Hyrax, a user can describe groups of steps they want to take to have an item “properly” reviewed. Hyrax uses workflows to describe these groups of steps to review an item that was ingested.

What is a workflow?

In Hyrax, a workflow is a state machine generated pragmatically by utilizing work done in a gem called Sipity. Each workflow can look different depending on who has designed it. By taking this info into account, it is now possible to generate any workflow a user would like by describing it in a JSON format.

How do I use the mediated deposit workflow that ships with Hyrax?

Hyrax comes with a one step approval workflow. You can see the file in config/workflows/mediated_deposit_workflow.json.

Make sure you’ve imported all of the files in the workflows directory:

rake hyrax:workflow:load

In order to use the mediated deposit workflow, you first need to create a new Admin Set and and assign it to use the workflow. You can do this either via the UI, or programatically.

Via the UI

Make sure you have an admin user. Look at your config/role_map.yml file and ensure that the user you want to have admin privileges is defined under an admin section, like this:

  development:
    archivist:
      - archivist1@example.com
    admin:
      - admin@example.com

Now, if you log in via the admin user, you should see an menu called “Administration” in the top left corner. Under it, you should see a menu item on the left called “Administrative Sets.” Under that menu, you can create a new administrative set. Give it a name and description and click save. Now you can ass