Email Alert Configuration
This document is to help PlantStar customers configure the Email Alerts for their Shop Alert Definitions.
The first thing you will need to do to get your Email Alerts working is to setup the Email Server your alerts will be filtered through. You will need to define seven (7) different categories.
Server Address: The FQDN or IP Address of the E-mail Server.
Server Port: The port your SMTP server is listening on (Default: 25)
Use TLS: Does your E-mail server require TLS Encryption
Use SSL: Does your E-mail server require SSL Encryption
User Login: Email address for PlantStar to send Alerts from
User Password: The password of the Address you wish to send Alerts from
Email From Address: This is usually restricted to the same credentials as the User Login information
Once these settings are made, you must click 'Save Settings' for the changes to take effect.
Once these are saved you may wish to send a test E-mail or Text Message to make sure the program is working correctly.
Simply add the Address you wish to receive the message and click the 'Send Test E-mail' button.
After you have all of the settings to your E-mail Server configured then you will need to define your Contact Lists through the Contact Lists tab on the Email Alerts Page.
To create a new list:
Select the 'New Contact List' button at the bottom of the screen, this will empty the text fields and give you the ability to add what List Name you would like, any comments for the list, and the initial contact email, or cellphone, you would like to use.
Note: To add a cell number, you must use the phone's 10-digit code and then the carrier's SMS gateway. E.g:
Verizon = @vtext.com
AT&T = @txt.att.net -You can find others at www.emailtextmessages.com-
T-Mobile = @tmomail.net
After you have created your first list you must click the 'Save Contacts' button for the changes to take effect.
After you have a list defined you can then add additional or edit existing addresses as you please.
To Add an Address to an Existing Contact List:
Select the List you would like to add to
Click the 'New Address' button at the bottom of the screen. (This will clear out the E-mail address field for you)
Type the E-mail Address you would like to add
Click 'Save Addresses' for your changes to take effect
-----
To Edit an Address to an existing Contact List:
Select the List you would like to Edit.
From here you can change the List Name, Comments, or (once selected) an Email Address.
Once your changes are made, click 'Save Contact List' for the changes to take effect.
-----
If there are any errors or you wish to delete a Contact List, or an Address defined in a list you can simply remove them.
To Delete an Address:
Select the Contact List you would like to edit.
Select the Contact's Address you would like to Edit.
Click the 'Delete Address' button.
To Delete a Contact List:
Select the List you would like to edit.
Click the 'Delete List' button at the bottom of the screen.
Note: These are irreversible and cannot be fixed once deleted. You will need to add the list or contacts in by hand once more.
----
There is also the ability to send a test email to every defined Contact in a list.
Highlight the list you would like to send the tests to and click 'Test Contact List'. If there are any errors then a pop-up will occur and none of the messages will be sent.
Once you have your Server Settings and your Contact lists defined you can then start defining the Escalation Lists that will be used for the PlantStar Alerts.
Note: These procedures will be applicable to both the 'Assist Alerts' and the 'Down Alerts'.
Adding Contact Lists to an Alerts List:
First choose which Definition list you would like to edit; the Assist or Down Alerts.
Then select the Reason Name you would like to add an Alert for.
Once there, you must select 'New Escalation', this will allow you to choose one of your pre-defined Contact Lists from the Drop Down Menu and the amount of time you wish to wait before the email is sent.
You must click the 'Save Escalations' button at the bottom of the screen for the changes to take effect.
----
Editing an Escalation List:
If you need to Edit the time of an Escalation level or the List of which the Alerts are being sent to
Select the Contact List that has already been defined
At the bottom of the screen the choice is given to change the Contact List or the amount of time for the escalation.
Click the 'Save Escalations' for the changes to take effect.
----
Deleting An Escalation List:
First select the Reason Name you would like to edit
Select the Contact List you would like to edit
Select the 'Delete Escalation' at the bottom of the screen to delete the Escalation.