Site Information#

The Site Information page lets you configure many site-level settings for Colectica Portal. It is located at /admin/site. After changing settings, click the Save button at the bottom of the page.

Note

Fields that accept HTML are sanitized when saved. Insecure HTML content, such as scripts, is removed.

Backup#

Click the Download site information JSON backup link at the top of the page to download all the settings on this page, including the configured item page buttons and basket buttons, as a JSON file.

General#

The first group of settings has no heading.

Site Name: The name of the site, as displayed in the upper left corner of the site
Site Title: The title of the site, as included in the HTML <title> element. This title is also reported to client applications as the name of the repository.
Theme Name: The name of the visual theme that determines fonts, colors, and other design elements. See Theme and Styles.
Allow Commenting: Determines whether to allow users to add comments to items.
Allow Rating: Determines whether to allow users to rate items.
Display EU Cookie Warning: Determines whether the EU cookie warning should be displayed when users first visit the site.
Show tours on first visit: Determines whether the user is shown a tour of the site on their first visit.
Cookie Warning Text: The text to display in the cookie warning bar. If left blank, the default is “We use cookies to track usage and preferences.”
Allow Data Download: Determines whether custom data extracts can be downloaded from baskets.
Disable dataset download links on dataset page for non-registered users: Determines whether the links to public data file identifications are displayed on the dataset page for anonymous users

Home Page Content#

Welcome Message: Text to be displayed at the top of the home page.
Secondary Welcome Message: Text to be displayed at the top of the home page, in the right column. If present, the Welcome Message (above) is displayed in the left column.
Custom HTML Content: Raw HTML to be displayed on the home page. This content will appear under the welcome message, if a welcome message is set.
Show Search: Determines whether the search box is displayed on the home page.
Types to Search: Determines which types of items to search when searching from the home page. If no item types are set, then all item types are searched.
Displayed Item Counts: Determines which types of items will show their item counts with links on the home page.
Item Lists: Determines which types of items will be listed directly on the home page.
Show grouped QuestionItem + QuestionGrid + QuestionBlock count: Determines whether a composite item count consisting of all QuestionItem, QuestionGrid, and QuestionBlock types is displayed on the home page. If enabled, it is recommended that none of the three question types are selected in the Item Counts setting, to avoid redundancy.

The item type settings open a dialog in which the item types are grouped by category: Studies, Data Capture, Data, Foundational, Quality, and Packaging.

Search#

Allow searching all types: If turned on, the /search/ page allows users to search for all item types. If turned off, only item-specific search pages are allowed (for example, /search/variables/).
Show series search facet: If turned on, the /search/ page allows users to filter results by series selected from a dropdown.
Show studies search facet: If turned on, the /search/ page allows users to filter results by studies selected from a dropdown.
Show data files search facet: If turned on, the /search/ page allows users to filter results by data files selected from a dropdown.
Show languages search facet: If turned on, the /search/ page allows users to choose which metadata content languages are searched.
Show deprecated search facet: If turned on, the /search/ page allows users to choose whether deprecated items are included in the results.
Show breadcrumbs in search results: If turned on, the /search/ page displays a breadcrumb trail at the top of the each search result.
Visible Item Types: Determines which item types are visible in the Item Types facet box. Other item types are available through the More button.
Results Page Size: The number of search results to be displayed per page. The default is 20.
Use POST instead of GET for search form: Determines whether the search form uses the POST or GET method. It is recommended not to enable this setting, because POST requests break backward navigation.
Show search targets dropdown: Determines whether the search form includes a dropdown to select the search target (e.g. search only item names or labels).

Login#

Allow Anonymous Access: Determines whether users who are not logged in can access the portal
Is registration allowed: Determines whether users who are not administrators can create their own accounts. If turned off, only administrators can create new accounts.
Registration page welcome message: Text to be displayed at the top of the registration page.
Login page welcome message: Text to be displayed at the top of the login page.

Content#

Footer Text

Text to appear at the bottom of every page.

Help Links

Links to be added to the help menu. Each line describes one link in the following format:

Link One,http://example.org/link1
Link Two,http://example.org/link2

HTML before </body>

Content to appear immediately before the closing body tag. This may include <script> elements.

Javascript files to include

Paths to Javascript files to include on every page. Each line should contain a single path.

Message for /explore

A message to be displayed on the /explore/ page when no concept is selected.

Message for /search

A message to be displayed on the /search/ page.

Message for /basket

A message to be displayed on the /basket/ page.

Message for /classifications

A message to be displayed on the /classifications/ page.

Use version specific links to Item Pages

If turned on, links to items throughout the portal include the item’s version number, so the link always shows the same version. By default, links open the latest version of the item.

Visualization#

Use concise concordance view by default: Determines whether the concise concordance view is displayed by default. If not enabled, the verbose concordance table is shown by default.
Use Line Charts not Bar Charts: For variable statistics, determines which type of chart is displayed.
Process Markdown In Category Labels: If turned on, Markdown formatting in category labels is rendered when the labels are displayed.

Email#

Email Address for Feedback: The email address to which messages from the Feedback form will be directed

Basket#

Types Allowed in Basket: Determines which types of items are allowed to be added to the basket.
Enable public basket sharing: If turned on, users can share their basket with others by providing a link.

User Profile#

Terms of Use: Text to be displayed on the user registration page. The user must check a box to assent to the terms.
Position Choices (one per line): Determines the options available in the Position dropdown on the user registration page.

PDF#

PDF documents are generated using the Typst typesetting system, which is included with Colectica Repository.

Enable PDF download: Determines whether users can download PDFs of items.
Style: The visual style of generated PDFs. Registry uses a modern sans-serif design with a blue accent. Monograph uses an academic serif design. The default is Registry.
Organization name: The organization name to be shown in the masthead of generated PDFs.
Logo image: The location on disk of a logo image to be shown in the masthead of generated PDFs.
Page Size: The page size of generated PDFs: either Letter or A4

API#

Types allowed for set creation: Determines the types of items for which users can download the item’s complete set as a single DDI file from the item page.

Note

The REST API itself is enabled with the API:EnableRESTv1 setting in appsettings.json. See Configure the REST API.

Web Scraping Protections#

These settings require users to log in before performing operations that are expensive for the server, to discourage automated downloading of the entire site. They have no effect on portals that do not allow anonymous access.

Require login for item page PDF downloads: Anonymous users cannot download PDF documents from item pages.
Require login for item page DDI set downloads: Anonymous users cannot download the full DDI set of an item.
Require login for item page version comparisons in history view: Anonymous users cannot compare versions of an item from the history page.
Require login for item page DDI downloads: Anonymous users cannot download DDI XML from item pages.
Require login for specific revisions of item pages: Anonymous users can only view the latest version of an item. This setting has no effect if version specific links to item pages are enabled.

Model Context Protocol#

These settings control the MCP server. They can only be changed when the MCP endpoint is included in your license. See Feature Access.

Enable MCP endpoint: Makes the MCP server available at /mcp.
Require authentication for MCP endpoint: Requires MCP clients to authenticate. This setting has no effect on portals that allow anonymous access.

OAI-PMH#

These settings control the OAI-PMH endpoint described in Discoverability and Harvesting.

Disable OAI-PMH: Turns off the OAI-PMH endpoint.
Require authentication for OAI-PMH: Requires harvesters to authenticate before using the OAI-PMH endpoint.
Lists latest item versions only: If checked, the OAI-PMH ListRecords and ListIdentifiers requests will only return the latest version of each item. If not checked, all versions are included.
Include deprecated items: If checked, deprecated items are included in OAI-PMH results.
Types of OAI-PMH sets: Determines the types of items that are exposed as OAI-PMH sets.