Rave Connector - Quick Start Guide

Connect Rave to your OneCampus instance.

OneCampus Administrators can now configure their OneCampus instance to pull alerts and notifications in from Rave Mobile Safety Service. This connector consists of two main features: The ability to automate the integration of Rave messaging (RSS) with OneCampus targeted notifications

And the ability to automate the configuration of emergency messages (CAP) with OneCampus alerts.

Administrators can configure the Connector to work with one or both of these features at the same time. Follow the instructions below to set up the Rave Connector within OneCampus.

Configure the connection between Rave and OneCampus

Start by clicking the Advanced menu, then click Connectors.
On the Connectors page, click the Configure button next to Rave Connector.
From the Configure Rave Connector page, you can determine the status of the Rave Connector by switching it on or off. For example, you may leave it off while you are finalizing your configurations and then turn it on when you are ready to go live with your end users. The default status is off.

As you complete the remaining fields on this page be keep in mind that you can configure this Connector to work for just RSS, just CAP Alerts or both RSS and CAP Alerts at the same time.
- If you only want to utilize the RSS, you only need to complete the RSS fields.
- If you only want to utilize the CAP Alerts, you only need to complete the CAP alert fields.
- If you want to use both the RSS and CAP Alerts, you will need to complete all of the fields below
Begin the RSS configurations by entering your Rave Site Name.
Enter the Minimum Channel.
- This is not the minimum number of channels, but rather the minimum channel to be scanned.
- In Rave, Channel = Endpoint.
  - For example, a channel endpoint looks like this: http://content.getrave.com/rss/{{siteName}}/channel1
- RSS Channels from Rave each carry a single message.
Enter the Maximum Channel.
- This is not the maximum number of channels, but rather the maximum channel to be scanned.
At this point, if you only wish to configure the Connector for the RSS feed, you may skip steps 8 through 10 below and click Save at the bottom of the page.
- Once saved, the Targeted Notifications envelope icon should appear on the main front page of your OneCampus tenant.
- Initially there may be no notifications listed in the Targeted Notifications area.
  - The connector will need to query the RSS channel every 10 minutes to retrieve and deliver notifications to end users.
- In order to see Rave RSS, it is not necessary for end users to be logged in.
- The RSS messages can adhere to OneCampus roles.
  - The Channel’s category will be treated as roleUniqueKeys in OneCampus.
    - The Channel's Category is a field within Rave.
  - Multiple roleUniqueKeys can be used with a space “ “ delimiter.
- RSS Channels from Rave each carry a single message. Once a message is sent from Rave in a given channel, it will continue to be displayed until another message is sent from the same channel, at which time the new message will replace the prior message from that channel.
- Published RSS messages can't be deleted, even if the message or the channel has been deleted. Users cannot delete or dismiss a message in the notification area (My Inbox). OneCampus will follow the RSS documentation from Rave to 'reset' an RSS feed. In order to do so, a subsequent alert should be posted to the channel with only the words ALL CLEAR in the description.
  
  Configure the connection between Rave (CAP) and OneCampus alerts.
  
  Before proceeding with the steps below, please select “Web Service” from the “Publish CAP message to” dropdown within Rave. This will ensure instant delivery to end users.
  
  Also, the Web Service URL should be https://{{OneCampusURL}}/rest-api/secure/CAP/alert
Enter a Username and Password that will be used to make the connection with OneCampus.
- The Username and Password will automatically create an API account within OneCampus.
- The Username and Password should be used with the Web Service Location in Rave, since the connection will Require Authentication.
- Username must be at least 6 characters in length.
- Password must be at least 12 characters in length.
Indicate Alert Severity Colors.
- If the severity element is provided, the connector will change the color of the alert based on the value provided here.
- Enter HEX colors (for example #f0320d) to designate extreme, severe, moderate and minor alerts.
- Extreme - Default is red
- Severe - Default is orange
- Moderate - Default is yellow
- Minor - Default is green
Enter Alert Duration
- This field controls the duration in hours for this alert to be active.
- Default duration is 6 hours.
Click Save.
- Once saved, when CAP alerts are sent from Rave, OneCampus will use the connector configurations to authenticate the request, set the alert colors, set the alert duration and display the alert to end users within OneCampus.
  - CAP Alerts can be Public or Private.
  - If the Scope element is set with a value of Public, the connector will create an alert.
    - Public alerts do not require login.
    - Public alerts show up as banner alerts in the header area.
  - If the Scope element is set with a value of Private (along with Addresses) the connector will create user specific targeted notifications.
    - An Address can be a username, a personId, an email, and/or a SAML 2.0 Authentication role attribute.
    - Addresses use a space “ “ delimiter.
    - Private alerts will only be visible when a user is logged in.
    - Private alerts show up in the targeted notifications area with a highlighted color.
    - Private alerts invoke the targeted notifications badge to indicate the number of notifications.