Setting up an Sender

Transcription

1 Setting up an Sender There are two different types of mail senders available in the Rock digitizers. There are E mail messages senders and E mail file senders. The file senders are used to send recorded files of various types, and the messages senders are used to send messages when specific situations occur, such as system startup, new event, or Alarm. You may have multiple E mail senders of either type in your layout, sending different messages and/or file types to different clients. Note that you need a sender module for each targeted recipient, so if you need messages sent to a lot of people, you should consider setting up distribution lists at the server end. There are also two different types of sending that can be done, sending directly using your own mail server or sending through a Kinemetrics supplied and maintained mail relay. Using the Kinemetrics mail relay is quite simple, but does require internet access and use of DNS in your network setup. Using your own mail server does not require either of these, but is more complex to set up and can be installation specific. If using your own mail server, it must support SMTP or ESMTP mail access. We will give examples here using an e mail message sender using both the Kinemetrics mail relay as well as using our own in house mail server. Note that the Kinemetrics mail relay is not accessible for SMTP/ESMTP traffic from outside.

2 Adding the module: Go to Advanced Features: Enable module add/remove:

3 Go to Module Add: Select the E mail message sender: The module is now added. You must now configure it for using the Kinemetrics mail relay or your own server.

4 Using the KMI mail relay: Go to System Operation parameters: Select the E mail message sender module:

5 Set the parameters to send messages. Note, I have only needed to set the following things: Using the KMI relay The destination user (who will receive the message) A subject line A string to be sent when there is an event (Remember, you need internet access and DNS enabled in order to use the KMI mail relay)

6 Click OK to apply changes: Click Apply Changes Now to restart the system with your new parameters:

7 After the system restarts, when a trigger occurs, a message will be sent as follows: The UID tag uniquely identifies the message as coming from your unit.

8 Using a dedicated mail server: Enable Password Editing under Advanced Features (your mail server may require authentication):

9 Passwords are normally hidden, so enter the parameter editor in such a way that they are shown: Understand that exposing passwords is somewhat risky:

10 Select the E mail message sender module: Set the parameters to send messages. Note, I have only needed to set the following things: Not using the KMI relay Specify the mail host (mail.kmi.com in our case) The mail client (how you identify yourself to the mail server) The destination user (who will receive the message) Who is sending the message (from user) A subject line A string to be sent when there is an event Note that you may have to specify a different IP port (rather than port 25) and you may have to specify authentication credentials (user and password) depending on the requirements of your mail server. You will likely have to get your IT people involved.

11

12 Click OK to apply changes: Click Apply Changes Now to restart the system with your new parameters:

13 After the system restarts, when a trigger occurs, a message will be sent as follows:

14 Tokenizing parameters into a message: Messages can include data from the system. These variables can be tokenized into a message. To find out what is available, you need to open a telnet connection to the instrument at port The password for this port by default is kmi. Type the password when requested and then type the command rtparams at the > prompt. You will see a list of values like this: You may been to increase the size of the scroll window of the telnet program (or PuTTY in this case) to see all of the values. Also, some values may only show up conditionally for example the value LastTriggerTime is only populated when there has been a trigger.

15 To use this value in a message, surround it in ^ characters in your message as follows: New event at ^LastTriggerTime^ The message you will be sent will now look like this: Tokenization can be done in the message or the subject line. If the message begins with "@", it specifies a text file that is to be opened, read, tokenized, and then transmitted. This allows longer messages that contain more information to be designed and to more closely fit the requirements of the end user. For example: EventEnd=@EventEndMsg.txt