Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Your site setup options in XNAT will be dictated by the type of XNAT you plan to run. Are you setting up a publicly-accessible data repository like XNAT Central? Or a tightly-controlled data gathering and QC application for a multi-site study, like IntraDB for the Human Connectome Project? Your PI's business goals will need to be reflected in these registration options.

Site Information

Site ID

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

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

This controls what site description shows up on the login page. You have the option of either entering the text of the site description directly using Markdown or specifying the path to the Velocity template file which contains what you want to show up for the site description. If you want to use a template file for the description, you should 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). 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 Login Landing

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

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.

Admin Information

Site Admin Email

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 should 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.

Site-wide Alerts

Enable Alert Message

This controls whether users will see site-wide alert messages. If it is set to 'Off', then there will not be any site-wide alert messages. If set to 'On (Login Page Only)', then a site-wide alert message will show up when people go to the login page. If set to 'On (Login and Site Header)', then a site-wide alert message will show up when people go to the login page and will also show up at the top of the page throughout the site. Site-wide alerts can be particularly useful to give users a heads up before the site goes down for scheduled maintenance.

Alert Message

This is the site-wide alert message that gets shown to users in the specified locations. If 'Enable Alert Message' is set to 'Off', this message will not show up anywhere. Otherwise, the site-wide alert will show up in the location(s) specified. This message can include HTML (e.g. if you want to add links or add emphasis to part of the message). If you change the alert message and Enable Alert Message is set to 'On (Login and Site Header)', then users that are already logged in will start seeing the new message as soon as they navigate to a new page.

Alert Type

This determines the visual appearance of the site-wide alert. By default this is set to 'Alert', but this can also be set to 'Message' or 'Error'. Each of these will appear in a colored bar right under the navigation drop-downs at the top of the page. Whether you select 'Message', 'Alert', or 'Error' will determine what color is used as well as what icon will appear to the left of the message. If you select 'Error', the bar will be red and will be more eye catching, but this may make users think that something has gone wrong. If you only want to alert users about scheduled downtime, selecting 'Alert' or 'Message' may be more appropriate. 'Message' is the least attention grabbing and should be used for the least critical messages.

  • No labels