Blog

Managing Virtual Implementation Sites

Posted in Partners & Implementation Sites on November 11, 2020

Compass now allows you to manage virtual implementation sites in a much easier way.  No more fake addresses, site names, etc.   Now, you can specify the delivery method of an implementation site, and the delivery platform.  When creating or updating an implementation site, you'll have 3 delivery method options:  In-Person, Telephonic, and Virtual.  

mceclip0.png

 

If you select Virtual, you will be presented with an option to choose a platform (Zoom, Webex, GotoMeeting, etc).  Once you start creating workshops under these new sites, the workshop's site name will automatically be populated based on the delivery method and platform you have chosen!  This will make your virtual workshops look consistent across the entire platform.

When generating reports for virtual and telephonic workshops, the partner organization's address will be used.

Compass Makeover!

Posted in New Features on November 11, 2020

Hello Compass Users!

We are happy to announce that on November 15th, the Compass application will be getting a HUGE makeover!

mceclip0.pngThe New Compass Workshop Page


First, a little backstory...

The current Compass design has been in place since the inception of Compass -- all the way back in 2013!  Though we feel the current design isn't bad, it is a little outdated.  It was not built to be mobile-friendly, attempts to cram a bunch of information into small areas, and sometimes makes it hard to manage your data.  

Well, we are now in 2020, and it's time for a change!

We want to bring you a fresh look that makes information easier to locate, read, update, as well as ensure it is mobile-friendly.  Additionally, we want to make the site easier to maintain.  This means that new features can be rolled out faster and easier.  

For the most part, your information will be located in the same areas within Compass.  We didn't want to shock you with moving data all over the place, but we did want to clean it up a bit and make it easier to read.  Data is more spaced out, forms are cleaner, and important information is highlighted.  

Below you will find several screenshots of the new design.  We always welcome your feedback, and would love to hear any questions or comments you have on the new design.  Please contact us at help@compasshp.org!

mceclip1.pngWorkshop Listing

 

mceclip2.pngPersonnel Listing

mceclip3.pngCreate Workshop Wizard

Sending waiver/consent forms via email

Posted in Workshops on October 27, 2020

Compass provides the ability to allow participants to electronically sign documents online.  When Compass personnel use the "E-mail Participants" feature, participants will receive an e-mail with a unique link to fill out their form.  When they click the link, they will be asked to verify their identity by entering their first and last initial to ensure it matches the participant record we have on file.  This is to prevent people from accessing surveys incorrectly.

Once the participant verifies their identity, they will be taken to the online form where they can enter their survey information.  Once they submit their signed form, their unique link is no longer valid, and they will no longer be able to access the document again.  This is to prevent links from getting into the wrong hands and potentially accessing personally identifiable information about a participant.

Detailed instructions can be found below.


Compass Personnel: Sending Waiver/Consent E-mails

Personnel in Compass can send electronic signature e-mails by visiting a workshop's page and clicking the "E-mail Participants" button at the top of the participant list (screenshot below).

mceclip1.png

A new window will open where the Compass user can select the PDF document they wish to send via e-mail, and verify the e-mail address for each participant.  If no e-mail address is on file, no e-mail will be sent.  You can also uncheck the "Send" checkbox to prevent sending an e-mail to the participant.

blobid0.png

Once you have verified all of the information, you can click "Send E-mails" and e-mails will be sent to each participant with an e-mail address.  


Participant: Receives E-mail

The participant will receive an e-mail that looks similar to the following:

mceclip0.png


Participant: Signs Document

Once the participant clicks the link in their e-mail, they will be taken to a page that asks them to enter their full name.  They will then be taken to the document where they can locate any areas where they need to sign.  Once they sign every required field, they will be asked to submit their document, and will have the opportunity to download a signed copy of the document.

 

 

Sending surveys via email

Posted in Workshops on October 27, 2020

Compass provides the ability to allow participants to fill out surveys online.  When Compass personnel use the "Send Survey via E-mail" feature, participants will receive an e-mail with a unique link to fill out their form.  When they click the link, they will be asked to verify their identity by entering their first and last initial to ensure it matches the participant record we have on file.  This is to prevent people from accessing surveys incorrectly.

Once the participant verifies their identity, they will be taken to the online form where they can enter their survey information.  Once they submit their survey, their unique link is no longer valid, and they will no longer be able to access their survey information again.  This is to prevent links from getting into the wrong hands and potentially accessing personally identifiable information about a participant.

Detailed instructions can be found below.


Compass Personnel: Sending Survey E-mails

Personnel in Compass can send survey e-mails by visiting a workshop's page and clicking the "E-mail Participants" button at the top of the participant list (screenshot below).

mceclip1.png

A new window will open where the Compass user can select the survey they wish to send via e-mail, and verify the e-mail address for each participant.  If no e-mail address is on file, no e-mail will be sent.  You can also uncheck the "Send" checkbox to prevent sending an e-mail to the participant.

mceclip1.png

Once you have verified all of the information, you can click "Send E-mails" and e-mails will be sent to each participant with an e-mail address.  


Participant: Receives E-mail

The participant will receive an e-mail that looks similar to the following:

mceclip0.png


Participant: Verifies Identity

Once the participant clicks the link in their e-mail, they will be taken to a page that asks them to verify their identity (screenshot below).

mceclip0.png


Participant: Fills out and submits online form

Once the participant has verified their identity, they will have the ability to fill out out and submit an online form.  Once they complete their submission, they will no longer be able to access the online form again unless a new e-mail is sent to them.

mceclip3.png

 

Adding Find-a-Workshop to your website

Posted in Workshops on November 18, 2020

Compass now provides your organization with the ability to add a Find-a-Workshop search directly in your website!  With just a few lines of code (described below) added to your site, potential participants can search for workshops and directly register without ever leaving your site!  

  1. Before You Begin
  2. Installation
  3. Pre-populate Participant Information
  4. Customizing the look and feel

mceclip0.png


Before You Begin

Please note that this will embed a large table and search box on your site.  Please make sure you place it in an area of your site that allows for a wide container (preferably 1200px).

An example of the complete installation can be found here: https://www.compasshp.org/find-a-workshop/index.html.


Installation

First, add the following snippet in the section of your page you would like to display the find-a-workshop.  All of the options available are described below the snippet.

<div id="compass-app"></div>

<script type="text/javascript">
var compass_options = {
owner_api_key: "[YOUR_OWNER_API_KEY]",
partner_api_key: "[YOUR_PARTNER_API_KEY]",
base_url: "https://compasshp.org",
callback_url: "[YOUR_CALLBACK_URL]",
ask_address: true,
history_mode: "hash",
};
</script>

<script type="text/javascript" src="//compasshp.org/find-a-workshop/dist/js/app.js"></script>

Configuration

To configure the Find-a-workshop feature, create a compass_options Javascript object.  You can then use the following properties to customize your installation.

 Attribute Description
owner_api_key

If you are a state organization, overseeing all organizations/partners for your state, this is the unique API key for your entity.  Providing this API key will only list programs and workshops for your organization.

You can locate your owner API key (if available) here: https://compasshp.org/in/api-keys

partner_api_key

If you are an individual organization and want to only list your workshops, you can specify this key.  Providing this API key will only list programs and workshops for your organization.

You can locate your owner API key (if available) here: https://compasshp.org/in/api-keys

base_url

(Optional) If you are testing out the find-a-workshop feature, and wish to point to a different environment other than the live Compass site, you can specify a different base URL.  For instance, you can point at the Compass demo site by specifying "https://dev.compasshp.org" in this option.

We recommend omitting this option before you go live, so you are always pointed at the live Compass site.

callback_url

(Optional) If you wish to have the find-a-workshop feature call a URL on your application once the participant has registered, you can specify that URL here.  The request will contain all of the participant's information that was requested on the Registration form, along with several additional elements:

  • id - The ID of the participant in Compass
  • organization_participant_id - The ID that was optionally passed in from the find-a-workshop search that links your organization's participant record to ours.
  • workshop_id: The Workshop ID from Compass
  • workshop_name: The name of the workshop (which includes the program name).
ask_address

(Optional) Set this to false if you do not want to ask for the participant's address.

Default value is true.

require_address

(Optional) Set this to false if you do not want to require the participant's address.

Default value is true if ask_address is set to true.

registration_message

(Optional) If you would like to display a message to potential participants, such as how their information is used, you can specify it in this field.  HTML is allowed in this parameter.  The default location of the message is at the top of the registration form, but can be placed underneath by setting the registration_message_position (described below).

registration_message_position

(Optional) If you are displaying a registration message (described above), you can specify either top or bottom in the registration_message_position parameter to place this message above or below the registration form.  

Default value is top.

history_mode

(Optional) There are 2 ways of browsing the find a workshop: hash and history

  • hash - default - Using hash will append all URLs in the find-a-workshop with a # sign when users are browsing the find a workshop.  For instance, when users perform a search, the URL bar will be appended with something like:

    http://www.yoursite.com/find-a-workshop#zipCode=1234&programId=22
    http://www.yoursite.com/find-a-workshop#/registration/3022.  

    Using this method means that you won't need to account for additional URLs on your server.
  • history - For advanced users - If you choose history mode, you will need to account for any sub-directories/URLs on your server when users are browsing your site.  When users are browsing the find-a-workshop on your site, URLs will appear in the following format:

    http://www.yoursite.com/find-a-workshop?zipCode=1234&programId=22
    http://www.yoursite.com/find-a-workshop/registration/3022

    In order for this method to work, you will need to add a wildcard catch-all on your server so that every portion of your URL after your default find-a-workshop link will automatically load the find-a-workshop page.  

Pre-populate Participant Information

If you are using a system that already has the participant's information in a database, you can prepopulate the registration form with the participant's contact information, so that your user does not need to manually enter that data. 

<!-- Amend your compass_options object -->
<script type="text/javascript">
var compass_options = {
owner_api_key: "[YOUR_OWNER_API_KEY]",
partner_api_key: "[YOUR_PARTNER_API_KEY]",
history_mode: "hash",

participant: {
organization_participant_id: "12345677ABCDEFG",
first_name: "Michael",
last_name: "Smith",
phone_number: "5188888888",
email: "mike.smith@somewhere.com",
send_email: false,
self_register: true,
address: {
address: "123 Main Street",
city: "Albany",
state: "NY",
zip: 12210
}
}
};
</script>

Configuration

If you are using the Find-a-Workshop feature in a system that already manages participants, you can add a participant object to the compass_options object, and populate it with the fields defined below.

 Attribute Description
organization_participant_id

If you wish to link the participant to your system, please specify your unique ID for the participant in this field.  Letters, numbers, and some special characters are allowed.

first_name

The first name of the participant.

last_name

The last name of the participant.

phone_number

10-digit phone number.  Numbers only!

email

E-mail address.  Required if you want to send a registration e-mail to the participant.

send_email

If an e-mail is provided, and this is set to true, a registration e-mail will be sent to the participant when they register.

self_register

Toggle true if the participant is registering for themselves.

address.address

The participant's street address.

address.city

The participant's city.

address.state

The participant's state (2 character state code!).

address.zip The 5-digit zip code for the participant.

Customizing the look and feel

The theme of the find a workshop search is based off of Bootstrap 3.  All of the styles associated with the theme are wrapped with the #compass-app element ID.  You can override any parts of the theme by adding CSS that customizes Bootstrap's theme.  For instance, to change the color of the buttons, you can apply CSS like so:

<style type="text/css">
 #compass-app .btn.btn-primary {
background-color: #204d74;
border-color: #122b40;
}
#compass-app .btn.btn-info {
background-color: #269abc;
border-color: #1b6d85;
}
#compass-app .btn.btn-danger {
background-color: #269abc;
border-color: #1b6d85;
}
</style>

All of the styles can be overridden by simply wrapping your CSS declaration with #compass-app.  Just inspect the element, find the CSS class, and customize away!