1. Set Up an AWS Account

Customers need to set up or have credentials of an AWS SNS Account. This will be the account from which the text messages will be sent. There will be additional costs associated with this.

1. Log into AWS console

2. Create an IAM policy using SNSPublishSMSOnly.json

3. Create an IAM user and store credentials

4. Attach this new profile to the user

2. Set Up Field for Phone Number in a User Trackor Type

The Administrator sets up a field that stores the Phone Number for the user who will receive the notification. This field should be added to a User Trackor Type. Phone numbers should be stored with country code in this field. Examples are +1(999)888-1234 and 19998881234. Field Format Validation can be used to ensure the entered value is in this format.

3. Set Up a Module Account and Security Token

The Administrator sets up a dedicated account for running the module. The module account will need the privileges listed below. Make sure you validate the account's credentials by logging in.

1. WEB_SERVICES R

2. ADMIN_NOTIF_QUEUE RE

3. ADMIN_USERS R

4. ADMIN_MODULE_LOG RA

5. <User Trackor Type> R (discussed in step #2 above)

6. <User Trackor Type Tab containing phoneNumberField> R (discussed in step #2 above)

Open

Now, the Administrator generates a security token specifically for the already created user. Record the Access Key and Secret Key which you will need to configure the module.

Open

4. Create Notification Service

The Administrator creates a notification service from Admin Center->System Administration->Services page. Make sure the Service has a Name, ‘is Enabled’ and type is ‘Notification.' Other values from this panel are not applicable as they will be obtained from the settings file in the module.

Open

5. Install and Configure Module

The Administrator installs the sms-notification module or users can install using VizionHub installing the latest version, currently this is 2.0.

Open

The sms-notification module that gets installed should be configured by setting values in the installation step or directly in the settings.json file as follows:

1. ovUrl- OneVizion URL

2. ovAccessKey - OneVizion Login (created in step #3 above)

3. ovSecretKey - OneVizion Password (created in step #3 above)

4. serviceId - ID of the Notification Service (created in step #4 above)

5. phoneNumberField - The name of the field which contains the phone number of the recipient. The recipient is a user Trackor related with User ID from the Notif Queue record. (created in step #2 above)

6. awsAccessKeyId - AWS Access Key ID (created in step #1 above)

7. awsSecretAccessKey - AWS Secret Access Key (created in step #1 above)

8. maxAttempts - The number of attempts to send SMS

9. nextAttemptDelay - The delay in seconds before the next SMS sending after an unsuccessful attempt

10. awsRegion - AWS Region. (defaults to us-east-1, which is one of the SMS enabled regions in AWS)

Open

Open

6. Create SMS Notification

After completing steps 1 - 5, users can create notifications on the Notifications page and select SMS Notification as the Notif Service so that the notification is sent as a text message. For information on creating notifications, see Notifications.

Investigating SMS Issues

Below are a few things Administrators can check on if Text Messages are not being received.

Module Runs: Is the Service Running?

Select the installed sms-notification module and open the Runs tab. This opens a grid that shows all the runs of the current module. The ‘Schedule’ configured in step#5 dictates the frequency in which the module runs. The default is set to run every five minutes. For test purposes daily interval is configured, but ~5 minute or less for the interval is recommended based on the sms notifications load. If you don't see any entries here, contact OneVizion Support to make sure your service is running.

Open

Clicking on the Status link (Executed with Errors) will provide more details. In the screenshot below, you can see that the Module failed to run because of invalid credentials in the settings.json file.

Open

Module Logs: Check for Errors Module Run

For successful Module Runs (Status - Executed without Errors), the logs pertaining to that run can be accessed by selecting the run record and clicking on the Log in the right corner.

Open

Notification Queues: Is My Notification Being Sent?

Administrators can access the Notification Queue page from Admin Center → Audits Logs menu. By filtering/searching on ‘Notif Service’ = “sms,” we can see the Queue Status and Error Message of the individual SMS notifications. In the screenshot below, a few SMS Notifications failed because the user(s) did not specify a phone number.

Open