Skip to content

Commit e6005f5

Browse files
committed
add brief description in readme.md and rename Broker class
1 parent c44f246 commit e6005f5

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
# TelegramAlerts
1+
# TelegramAlerts
2+
3+
Telegram bot created to get Alerts from Ensemble on your mobile phone
4+
5+
## Steps to add to your Ensemble Production
6+
7+
1. Create your bot using BotFatner (https://telegram.me/BotFatner) and get a token
8+
2. Create client SSL configuration in Management Portal
9+
3. Import classes (Telegram package)
10+
4. Create Lookup Table in your Ensemble namespace. Add one or more records. Use phone number (without "+" prefix) as a key.
11+
5. Add in your Production business operation TelegramOperation, in its settings, you must specify TelegramToken and SSLConfiguration
12+
13+
For getting updates from Telegram do one of the following (6 or 7):
14+
6. Long polling. Add TelegramService business service to your Production and configure it. Specify TelegramToken, SSLConfiguration, TableName (Lookup table name). Set call interval.
15+
7. Webhook
16+
* Create web application and Specify Dispatch Class parameter as Telegram.RESTBroker.cls
17+
* Configure SSL on your Web server
18+
* Call method SetWebhook of class Telegram.API to set webhook.
19+
* Add TelegramService business service to your Production. Specify TableName (Lookup table name). Set "Pool Size"=0.
20+
21+
8. Add AlertOperation.cls with the name Ens.Alert to the product and configure TelegramToken, SSLConfiguration, TableName
22+
9. Done!

Telegram/Broker.cls renamed to Telegram/RESTBroker.cls

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Class REST.Broker Extends %CSP.REST
1+
Class Telegram.RESTBroker Extends %CSP.REST
22
{
33
XData UrlMap
44
{

0 commit comments

Comments
 (0)