...
| Expand |
|---|
|
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. | Info |
|---|
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. | Info |
|---|
“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 publicallypublicly. | 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. | Info |
|---|
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. | Info |
|---|
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. |
|
...
| Widget Connector |
|---|
| overlay | youtube |
|---|
| _template | com/atlassian/confluence/extra/widgetconnector/templates/youtube.vm |
|---|
| width | 400px |
|---|
| url | https://www.youtube.com/watch?v=TBoaBuRb_hc |
|---|
| height | 300px |
|---|
|
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.
...
| Info |
|---|
A good practice would be to create a subdomain URL like covid-catalog.yourinstitute.edu and redirect to the Catalog's URL. AlsoFurthermore, you can hyperlink the URL from your biobank's website. |
...
| Expand |
|---|
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.  Image Removed Image AddedOn the collection protocol list page, the user can view the 'View Catalog' icon and other icons. Click the 'View Catalog' icon.  Image Removed Image Added
|
Set Default Catalog
...