OpenSpecimen supports creating multiple specimen catalogs. The catalogs can be private (needs login) or public (accessed without login). Catalogs can also be CP-specific. Each catalog will have its URL that can be shared with researchers.
Catalog configuration allows users (admins) to choose the views of the Dashboard, Catalog, Cart, and Request they would like to expose to the researchers. Refer to Catalog Configurable Views for more details.
Catalog Fields Description
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: When Filters are Selected, On Load)
'When Filters are selected': specimens are displayed on the catalog result view only after researchers select at least one filter.
'On Load': specimens are displayed on the initial page load—i.e., even when no filters are selected.
“On load” is recommended only when the number of specimens in the Catalog is low (say in the 1000s).
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.
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.
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
Add/Edit Catalog
Before starting to create the Catalog, make sure you have the following ready:
Navigate to 'Catalogs' from the menu bar.
Click on the '+Create' button from the catalogs list page.
Enter all the details → Create. Refer to the “Catalog Fields” table above for a description.
Save the Catalog.
Upon saving the Catalog, a URL is displayed on the overview page.
Click on the URL to access the Catalog.
Specimen-Based Catalog
The specimen-based catalog displays specimens as unique rows instead of counts. You can create the “Search query” to display specimens as unique rows in the Catalog.
Count-Based Catalog
Count-based catalog displays the count of specimens along with their respective data. You can create the “Search query” to use aggregate counts to display specimen counts instead of the list of actual specimens in the Catalog. E.g., count specimens for each type, per patient, visit, etc.
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.
CP-Specific Catalog
Admins can create catalogs that CP-specific users can access by setting the catalog at the CP level.
Create a CP-specific search and specimen query. Refer to the wiki a page for more information on queries.
Create a catalog using the CP-specific search and specimens query.
Go to the Collection Protocol overview page → Settings → Catalog
Click on the 'Add' button, select the catalog created with CP-specific queries, and click on the 'Save' button.
On the collection protocol list page, the user can view the 'View Catalog' icon and other icons. Click the 'View Catalog' icon.
Set Default Catalog
Any public catalog can be set as 'Default catalog', which appears when the OpenSpecimen login page is accessed.
Navigate to 'Settings'.
Click on the 'Default Catalog' property from the 'Catalog' settings module.
Add the catalog's identifier to be set as the default catalog under the 'New Value' field and click on the 'Update' button.
