Communication setup

From InsightWiki
Revision as of 10:21, 12 April 2019 by Admin (talk | contribs) (Push Notifications)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Insight is capable of sending SMS messages or emails. For these features to work, a little configuration is required.

The following role options are required to configure emails and/or SMS messages in Insight:
Manage > Preferences (On)

SMS

To configure Insight to send SMS messages, go to:
Manage > Preferences > SMS

If you do not already have an account with TextAnywhere, click the Get an account link beneath the Your Textanywhere client identifier field. This will take you to the website for TextAnywhere.

Once you have a TextAnywhere account, enter the client identifier and client password into the relevant fields in Insight. You will also need a TASC authorisation number. Contact the helpdesk to obtain this.

If you would like to receive SMS replies in an email, enter the email address for replies in the Email address for SMS replies field. You can use multiple email addresses by separating each with a semi colon. SMS messages from Insight will be sent from a randomly generated mobile number.

Alternatively, you can enter a word or phrase of up to 11 characters in the Fixed originator string field. The SMS messages sent from Insight will be sent from this word/phrase, rather than from a randomly generated mobile number. Users will not be able to reply to SMS messages if you use this option.

Once you have entered the required details, click the Update button at the top right of the page. Next click the Send a test SMS link and enter your own mobile number. You will either successfully receive an SMS, or Insight will display an error explaining why the SMS failed.

Email

To configure Insight to send emails, go to:
Manage > Preferences > Email

You must enter details for the following preferences:

  • Your SMTP server name or IP address
  • Your Reply To email address

All Insight emails will be sent from the email address that you enter as the Reply To email address. This does not need to be a real email address e.g. noreply@school.com

You can also enter details into the Optional display name for sender preference, which adds a display name to all emails sent from Insight.

You may need to enter the following preferences, depending on your email setup:

  • Username used to authorise against the SMTP Server
  • Password used to authorise against the SMTP Server
  • Enable SSL for SMTP
  • Optional port to use for SMTP (leave empty for default)

Once you have entered the required details, scroll to the bottom of the Email section. There are several preferences with a Send a test email link. Enter your email address into one of these fields then click the Update button at the top right of the page. Once you have updated, click the Send a test email link. A popup will show you the result of this test. You should test using both an internal and external email address.

Advanced Options

Insight emails are sent in the background on a timer loop. If you are running Insight on two servers then you need to disable one of the timer loops. To do this you will need to edit the web.config file for Insight which is found in the Insight directory, typically:
C:\inetpub\wwwroot\INSIGHT\web.config

Look for a setting called ProcessEmails. This should be set to Yes on only one server:

<setting name="ProcessEmails" serializeAs="String">
  <value>Yes</value>
</setting>

Push Notifications

Insight can send push notifications to Insight App users under various circumstances. Any messages sent via the Notice composer in Insight will trigger a push notification. The push message is defined via:
Manage > Preferences > Notices > Push message to use when new notices are created

The following preference can also be used to send an email to non-Insight App users, where an email is not otherwise going to be sent (in order to replace the push notification for the users who cannot receive it):
Manage > Preferences > Notices > Email the push message when the notice is not send via SMS nor Email

Push notifications from PARS

PARS can trigger push notifications in Insight for various events. Currently PARS can trigger push notifications when the following events are recorded:

  • Emails / SMS messages / Letters
  • Merits
  • Demerits
  • Detentions
  • Removals
  • Assignments

In order for PARS to trigger push notifications, you must create an API Key in Insight. The API Keys page explains the settings needed for PARS to trigger push notifications.