From version 11.1
edited by Su Hyun Hwang
on 2019/02/28 16:20
To version 12.1
edited by Su Hyun Hwang
on 2019/02/28 16:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,13 +6,95 @@
6 6  The alarming mail contains information of the variation, if there are some changes of values in a gateway between last two days. All the valid** **values should be maintained in transferring the data from gateway or databank to the server. E.g. the number of sensors of a gateway should be arrived to the server under total amount of sensors and furthermore their quality, so called good-data or gold-data, should be guaranteed. Sometimes they are related each other, so one deteriorated or improved data type leads to another value types changes. Mostly you will receive two mails, one is for the thermostat-data-quality and one for the electric meter, rexometer.
7 7  
8 8  
9 -=== Manual generating and simulating the message ===
9 +=== Messaging Providers ===
10 10  
11 -It is already programmed to make an email after auto-evaluation, but you can also do this manually in the server-website. You can simulate sending messages in your local pc and sending a message in real server is also very similar. You can read the section ‘Automail von Semaserver’ in this page. Here you can learn how to set the sender and receiver and where to find send message button in the application: [[Support Infrastructure and Processes>>https://www.ogema-source.net/wiki/display/SEMA/Support+Infrastructure+and+Processes]]
11 +In OGEMA these providers are available in the repository: Email, SMS(via Email), XMPP, Telegram, Pushover, OGEMA REST
12 12  
13 -After following the steps in above link, you will receive the mail. However, please notice the sending messages should be done after daily evaluation. If you want to get an email before the auto-evaluation and send an email to your email account, you will receive an email with a lot of incorrect message lines, because this mailing service is for today’s evaluation, not for the yesterday’s. In the email with right information you can read changes, which values in which gateways are jumped up or fell down. From these alarms you have to consider what is the reason of occurring the errors and how can you fix it, if the alarm reports errors. More about the evaluation for occurring and resolving errors in a given period, e.g. a week, a month or a year, with the messages, refer to this page: [TODO: create a new page in intern site].
13 +**Email**: Managing a Email will be written in the next part 'Manual generating a message'.
14 14  
15 +**SMS (via Email)** : The sending of SMS works via email. Typically, it is necessary to create a paid account at an email2SMS service provider for this purpose. Again, the password for the email account needs to be stored on the box.
15 15  
17 +**XMPP**
18 +
19 +**Telegram**: The connector for the telegram messenger works via a so-called Telegram bot, which acts as the sender for the messages. See also the bot API documentation: https:~/~/core.telegram.org/bots/api.
20 +
21 +The service requries two main configuration parameters, the bot ID and the chat ID (to create the latter, you need to send a message from your account to the bot once, and use for instance the getUpdate-API of the bot to find out the chat id, as explained here: https:~/~/stackoverflow.com/questions/32423837/telegram-bot-how-to-get-a-group-chat-id). To start the service, the following system properties must be set:
22 +
23 + org.ogema.messaging.telegram.key -> bot id
24 +
25 + org.ogema.messaging.telegram.username -> bot name (just for display)
26 +
27 +Then use the configuration page of the Telegram connector to add a user and set your chat id. Note: if the bot you are using is your private one (i.e. not shared by multiple users), you can configure the connector to automatically create the user once it receivces a message. For this purpose set the system property
28 +
29 + org.ogema.messaging.telegram.privatebot=true
30 +
31 +TODO screenshot telegram connector config page.
32 +
33 +Potential sources of error: If you delete the chat with the messaging bot, your chat id will be gone and message forwarding towards this chat id doesn't work anymore.
34 +
35 +**Pushover: TODO**
36 +
37 +**OGEMA REST :TODO**
38 +
39 +
40 +=== Manual generating a message ===
41 +
42 +It is already programmed to make an email after auto-evaluation, but you can also do this manually in the server-website. You can simulate sending messages in your local pc and sending a message in real server is also very similar.
43 +
44 +
45 +~1. You should first set sender and receiver. In the Message Settings app you can first configure receiver. Click the Button 'Create new receiver', fill the receiver’s name and email-address. After Accepting the receiver will be set and shown on this page. You can any time edit this setting.
46 +
47 +(% style="text-align:center" %)
48 +[[image:https://www.ogema-source.net/wiki/download/attachments/13467689/firefox_2018-12-10_12-54-48.png?version=1&modificationDate=1544443635341&api=v2||height="263" width="767"]]
49 +
50 +
51 +
52 +2. To configure the sender, go into 'Edit senders' under the Select page menu. Likewise, you can give sender’s name and email-address. But you also need to write password and server-URL and port.
53 +
54 +(% style="text-align:center" %)
55 +[[image:https://www.ogema-source.net/wiki/download/attachments/13467689/firefox_2018-12-10_12-53-36.png?version=1&modificationDate=1544443547835&api=v2||height="307" width="730"]]
56 +
57 +How to configure your application to send a message to the configured receiver -> See ‘’
58 +
59 +
60 +3. To be able to receive messages from one of the provider presentated above, you have to create a forwarding configuration. For every message sending App you can send configure how you get messages from it. By setting the dropdown option to a priority you choose to receive (LOW, MEDIUM, HIGH) or not receive (NONE) messages from this specific App, the default value is "NONE". If a value is selected, you will receive messages from this App with a priority equal or higher than the set one.Example (Here we want to receive Messages with a priority of LOW or higher (all messages) from the evaluation-offline-control via Email-connector):
61 +
62 +(% style="text-align:center" %)
63 +[[image:image-20190228161905-13.png||height="303" width="695"]]
64 +
65 +
66 +4. Now go into the ‘evaluation-offline-control’ app and click the Start button on the line ‘basic-quality-room-windowsens’.
67 +
68 +5. Still you can’t find ‘MultiKPI’ pages under the ‘Set Page’ menu, where you actually send mails. To create this page, you should click the button ‘Add KPI-pages offered by provider’ on right side at the bottom of the page. Then you will see the pages 'MultiKPI: basicQualityStd' and 'MultiKPI: rexoQualityStd'.
69 +
70 +6. In these pages you can find the Button 'Send Message'. Click the button and you will receive a mail in a few seconds.
71 +
72 +7. You can also check whether the message was sent in the ‘message-reader’ or right upper side box on the page of offline-evaluation-control. You can see the history of message sending from the server.
73 +
74 +[[image:image-20190228161754-6.png||height="181" width="129"]]
75 +
76 +[[image:image-20190228161753-3.png||height="276" width="619"]]
77 +
78 +
79 +After following the above steps, you will receive the mail. However, please notice the sending messages should be done after daily evaluation. If you want to get an email before the auto-evaluation and send an email to your email account, you will receive an email with a lot of incorrect message lines, because this mailing service is for today’s evaluation, not for the yesterday’s. In the email with right information you can read changes, which values in which gateways are jumped up or fell down. From these alarms you have to consider what is the reason of occurring the errors and how can you fix it, if the alarm reports errors. More about the evaluation for occurring and resolving errors in a given period, e.g. a week, a month or a year, with the messages, refer to this page: [TODO: create a new page in intern site].
80 +
81 +
82 +=== Messaging Test ===
83 +
84 +Send messages from the test app via its user interface. The messaging test app user interface.
85 +
86 +(% style="text-align:center" %)
87 +[[image:image-20190228161755-12.png||height="307" width="500"]]
88 +
89 +
90 +==== In case of being unable to be sent a message ====
91 +
92 +Manchmal wegen fehlendem Mail-Protocol könnte eine generierte Mail nicht geschickt werden. Dann check das Mail-Programm:Einloggen In web.de (ID: testtransmitter@web.de, PW: siehe Semaserver Message Settings)Menü: Einstellungen > E-Mail > Zu den Einstellungen > POP3/IMAP Abruf>WEB.DE Mail über POP3 & IMAP, Häkchen check und Speichern.
93 +
94 +* POP3 und IMAP Zugriff erlauben
95 +
16 16  === How to develop messaging configuration ===
17 17  
18 18  You may have better ideas how we more efficiently monitor by messaging and want to edit settings or add some information. You should just modify the right codes on your local pc and adapt to the server. You can modify the code in the path [/timeseries-dataquality-analysis/src/main/java/org/ogema/timeseries/provider/tsquality]. After then replace the source in server. Replacement the source in server and update the server: [TODO: insert the link serverupdate-page]
99 +
100 +