Introduction

OpenSpecimen facilitates the creation of multiple specimen catalogs. These catalogs can be designated as private (requiring login) or public (accessible without login). Additionally, catalogs can be specific to certain clinical protocols (CP-specific). Each catalog will possess its URL, which can be shared with researchers.

The catalog configuration enables users (administrators) to select the views of the Dashboard, Catalog, Cart, and Request that they wish to make accessible to researchers. For further details, please refer to Catalog Configurable Views.

Catalog Privileges

The following users can add/edit a catalog:

Super Admin
Institute admin
Any other user with a role create/edit privilege on the 'Catalog' resource

Catalog Pre-requisites

Before starting to create the Catalog, make sure you have the following ready:

Pre-requisites

Saved queries to used Search & Item details query. Refer to theReporting page for more information on queries.
A Request Form. Refer to Custom Forms

Create Catalog

Navigate to 'Catalogs' module
Click on the '+Create' button on the catalogs list page.
Enter all the details → Create. Refer to the Catalogs Creation | Catalog Fields table for field details.
Save the Catalog.
Upon saving the Catalog, a URL is displayed on the overview page.
Click on the URL to access the Catalog.

Catalog Fields

Field	Description

Field	Description
Title	Display the title of the Catalog
Description	Description of the Catalog. It will be displayed on the catalog page.
Display	This option allows users to control the contents of the Catalog finely. Users can select one or more options based on the intent of the Catalog. You can create a catalog with the following combinations: Dashboard only Dashboard and Catalog Dashboard and Request Dashboard, Catalog, and Request Dashboard, Catalog, Cart, and Request Catalog only Catalog and Request Catalog, Cart, and Request Request only
Search Query	Select a query to display in the Catalog's result view. Users can control the fields displayed and specimens included/excluded within this query.
Search Result Columns	A subset of the columns to display in the catalog result view. This is useful when you have many columns in the “Search query” results view and want to show minimal/default columns to the researchers. If no columns are selected, all columns in the query are displayed by default. Researchers can add additional columns when viewing the Catalog.
Search Items HTML
Item Details Query	This query is used to Display the requested specimens to the request managers. Attach CSV in the email notifications to the request managers and requestors (OpenSpecimen users only). Having two queries allows you to configure different columns for the request managers vs. researchers. This query must include the 'Specimen > Identifier' column in the results view.
Request Form	This custom form is the ‘request form’ that the researchers must fill out during request submission. Each catalog can have its request form.
Request Managers	One or more users who: The user will receive an email notification when a new request is created. Can view, approve or reject the requests.
Show Items	Options shown are 'When Filters are selected' (records are displayed only after selecting a filter) and 'On Load' (records are displayed even when no filters are selected)
Requires Login	If 'Yes' is selected, the researchers must log in to access the Catalog. If not, then the Catalog can be accessed publicly.
User Groups	Applicable for private catalogs. Only this ‘User Group’ user can access the Catalog if configured. If no user group is selected, the Catalog is accessible to all users. This is useful if users restrict the Catalog to a subset of users.
Show App Buttons	It hides buttons like 'sign in' or 'sign up on top of the page. This is useful for the public Catalog to give a clean user interface where researchers are not distracted by unwanted buttons.
Help URL	Users can create a catalog-specific Wiki or SharePoint page to document how the researchers can use this catalog. A help button will appear beside the Catalog's name.

Check the below pages for creating different types of catalogs:

Sharing Catalog URL with researchers

You can share the URL displayed on the Catalog overview page. If the Catalog is private, the researchers must log in to OpenSpecimen before accessing the Catalog.

A good practice would be to create a subdomain URL like covid-catalog.yourinstitute.edu and redirect to the Catalog's URL. Furthermore, you can hyperlink the URL from your biobank's website.