Site-wide Alerts
Overview
The Alerts feature provides an opt-in site-wide alerting system, producing one or both on a website at the top of the page.
Enable the site-wide alert feature for a site collection
The Site Wide Alert is an opt-in feature. It is disabled by default to enhance overall site performance, as it is rarely used.
Modify the agency.js file
- Locate the agency.js file in the Style Library at the root of the site
'View All Site Content' > 'Style Library' > 'JS' > 'agency.js' - Check out the file
- Use the ribbon command to download a copy of the file
- Open the file in Notepad or a simple text editor. Do not edit this file in a word processor as it can add illegal characters.
- Add the following to the file on a new line
oregon.agencyWideAlert.enabled = true;
- Save the file as 'agency.js'
- Upload the file to the 'Style Library' > 'JS' You may be prompted to replace the existing file or not. Choose Yes
- Check in and Publish the 'agency.js' file
Configure the site settings
- Click the gear icon in the upper right corner and select 'Site Settings'.
- Click 'Template Settings' from the 'Starter Template v4.x' section.
- Check out the template settings and click on the 'Alerts' link on the left navigation.
- Select where you want to inherit the data source from
- Default: This option will only be available on the root of the website. The default data source is defined as local.
- Inherit: This will change depending on if you are in the root of the website or in a subsite. Inherit will copy whatever settings the root site has.
- Root Site: This will use the data source the base website
- Local Site: This will use a data source from a subsite, allowing you to have subsite specific alerts. This will require you to create a new 'Site Wide Alert' list.
- Toggle the 'Enable Sitewide Alerts' checkbox.
Add an alert to the site
Locate the 'Site Wide Alert' list at the root of your site. Add a new item, filling out the Title, Alert, and choosing Yes from the dropdown in the Display column.
Requirements
- Browser must meet the statewide minimum requirements
- Access to statewide-links.js on CDN
- List titled Site Wide Alert
- Site-wide alert feature must be enabled, manually
- Starter Template v4.5+
Accessibility
This web part passes both WCAG 2.0 and Section 508 website standards. Alert has the proper role of alert and aria-live role of polite. Links are well-formed. Colors pass contrast ratio requirements.
Features and Functionality
- Additive approach based on alert message existence
- Statewide alert is sticky, along with top nav bar
- Alert can be suppressed for 24 hours by way of a close button
Known Limitations
None.
Frameworks/Libraries Dependencies
Feedback
If you would like to suggest features, enhancements, or report a bug, please visit https://egovservicedesk.zendesk.com and open a new ticket.
Comments
0 comments
Article is closed for comments.