Page tree
Skip to end of metadata
Go to start of metadata


The default tab that loads in the Admin UI allows you to set your basic site settings. Many of these settings were initially configured in your XNAT First Time Configuration step, but can be changed here as needed. To get to these controls, go to Administer > Site Admininistration in the top navigation and click on the Site Setup tab.  

Site Information Settings

Settings

SettingProperty NameDescription
Site ID
siteId

The ID used to refer to this site (also used to generate database ids). The Site ID must start with a letter and contain only letters, numbers and underscores. It should be a short, one-word name or acronym which describes your site. No spaces or non-alphanumeric characters. By default this is set to 'XNAT', but you will likely want to change this to the name of your particular XNAT instance (e.g. 'ConnectomeDB' for the Human Connectome Project public site). This Site ID will appear throughout the site, such as on the page users are directed to after login which informs them how many projects, subjects, and imaging sessions the site has (e.g. SITE_ID currently contains 2 projects, 3 subjects, and 4 imaging sessions.).

Site URL
siteUrl

This is the URL at which users should access your site. It should be the full URL, including 'http' or 'https'. This URL is the one provided to users in emails, and other external links. This should be a functional address (i.e. if the user pasted this address in their web browser, they should come to the site). localhost only works if the web browser is located on the same machine. You are required to guarantee that this address is functional for reaching the site.

Site Description
siteDescription

This controls what site description shows up on the login page. You have two options for configuring this content:

  • Page (Default): Select the 'Page' radio button and then enter, in the text field below the radio button, the relative path to the site description template (e.g. /screens/site_description.vm). 
  • Markdown: If you want to enter the description directly, you should select the 'Text (Markdown)' radio button and then enter, in the text box below the radio button, the site description using Markdown.
Site Description (Text)
siteDescriptionText

This setting only gets used if Site Description is set to "Markdown"

Markdown is a simple syntax used by GitHub and many wikis for creating text content with headline styles, links, images and other emphasis tags. See: Markdown Quick Reference

Site Description (Page)
siteDescriptionPage

This setting only gets used if Site Description is set to "Page"

The file path should be relative to the XNAT webapp templates directory, and will typically be something like /screens/{templatefile.vm}.

Site Login Landing
siteLoginLanding
This is the relative path (e.g. /screens/QuickSearch.vm) to the Velocity template page that you want users to land on upon logging in.
Site Home
siteHome

This is the relative path (e.g. /screens/QuickSearch.vm) to the Velocity template page that you want users to land on when they click the XNAT logo in the menu bar.

Paths specified in these input fields relate to files that are located in your webapp's template folders. See "Managing Template Files" in Understanding the Components of XNAT

Site-wide config properties can be accessed via REST at /xapi/siteConfig/values/{property-name}.

Site-wide config properties can be access programmatically in Velocity via $siteConfig.{property-name}.


Admin Information

Admin Information Settings

SettingProperty NameDescription
Site Admin Email
adminEmail

The administrative email account to receive system emails. This address will receive frequent emails on system events, such as errors, processing completion, new user registration and so on. These emails can be configured on the Notifications tab.

This must be a valid email address. If it is not, then some emails intended for other recipients may also fail if there's an error caused by an invalid email address being one of the recipients.

Primary Admin Username
primaryAdminUsername

This should be the login name of an enabled and valid user. The specified user must be a site administrator.


Site-wide Alerts

Settings

SettingProperty NameDescription
Enable Alert Message

siteWideAlertStatus

Toggles between three possible settings:

  • "0": Off
  • "1": On, displaying only on the login page
  • "2": On, displaying on login page and site header
Alert Message

siteWideAlertMessage

Message text. Can be plaintext or HTML.
Alert Type

siteWideAlertType

Toggles between three alert types:

  • "Message": Used for non-urgent informational alerts, such as to notify users of a new feature
  • "Alert": Used for urgent informational alerts, such as to notify users of a scheduled outage
  • "Error": Used to notify users of unexpected errors, such as unscheduled downtime or an outage of a related service, such as pipeline processing