Differences

This shows you the differences between two versions of the page.

--- public:en:simsalert:start [2022/07/28 17:47] – Johan Lundblad
+++ public:en:simsalert:start [Unknown date] (current) – removed - external edit (Unknown date) 127.0.0.1
@@ Line 1: / Line 1: @@
-{{ :logo.png?nolink&100|}}
-====== User manual SIMSAlert(English) ======
-**[[public:start|Back to Public Documents]]**
-===== Introduction =====
-The SIMS Alert application is used to notify selected users about events that occur in the SIMS system via SMS messages. \\
-The application consists of two parts, the server, and the administration interface. \\
-The server is responsible for receiving and analyzing information from SIMS system and sending defined messages to selected phone numbers. \\
-Administrative interface in a form of web application allows for precise configuration of sent messages and administration of phone numbers, to which these messages will be sent. \\
-The application allows you to define which type of alarm, from which system and area, as well as at what time interval the message is to be sent. \\
-In addition, you can define the exact text of the message using the available built-in parameters or any text. \\
-The administration interface also allows viewing the history of sent messages.
-The following items are **required** to use the application.
-  * An installed and configured SIMS Alert server application
-  * Active license
-  * Active SIMS operator
-  * Web browser (e.g. Chrome, Edge, Opera, FireFox, Safari)
-===== Login for the first time =====
-Enter the address of the SIMS Alert server in your web browser. \\
-{{.ip.png?nolink|}}
-Use the same user and code you are using to log in to SIMS. \\
-{{.login.png?nolink|}}
-===== User administration =====
-After the first login to the application you need to add a user for settings administration.
-  * The name of the first user must be consistent with the name of the existing SIMS operator
-  * The phone number is not important, but you must enter at least 4 digits for the system to save the data
-  * Check Allow editing for users who will be able to edit settings
-After filling in the data, click on Update. \\
-{{.user1.png?nolink|}}
-Then you can add people to whom SMS messages will be sent. There is no association with a SIMS operator here. \\
-{{.user2.png?nolink|}}
-===== Definition of templates for SMS messages =====
-{{.template1.png?nolink|}}
-Add a new SMS definition. \\
-{{.template2.png?nolink|}}
-Example, complete the following fields:
-  * Definitions name, e.g. Intrusion alarm in the server room area
-  * Select the System from the list \\ {{.system.png?nolink|}}
-  * Select the area from the list e.g. Server room \\ {{.area.png?nolink|}}
-  * Select the area state from the list e.g. armed \\ {{.areastate.png?nolink|}}
-  * Select the alarm type from the list e.g. Intrusion \\ {{.alarmtype.png?nolink|}}
-  * For additional specification, we can use the text filter \\ {{.regex.png?nolink|}} \\ Use regular expressions syntax \\ You can simply find the text in entire message: ''abc'' \\ Or find one of two words: ''abc|def'' \\ Use ''{m,n}'' or ''{m}'' for counters, for example ''a{2,4}'' matches "aa","aaa" and "aaaa". \\ Use brackets for sets, for ex. ''[A-Za-z0-9]'' means "alphanumeric sign" \\ Use quantificators : \\ ''?'' : zero or one sign, matches \\ ''*'' : zero or more signs \\ ''+'' : one or more signs \\ For example: \\ ''[hc]?at'' matches "at", "hat", and "cat". \\ ''[hc]*at'' matches "at", "hat", "cat", "hhat", "chat", "hcat", "cchch23452345at", and so on.\\
-  * Specify when to send messages of this type or leave the fields blank if you want the definition to be active all the time. \\ {{.time.png?nolink|}} \\ If you want the template to be active during selected hours and only on working days, check the option Filter hours active only in weekdays. \\ {{.filter.png?nolink|}}
-  * Enter the text, that will be sent in the SMS body. \\ You can use following templates: <code>{SystemName}, {AreaName}, {InputName}, {InputNameNox}, {InputTypeName}, {AreaStateName},
-{AlarmID}, {System}, {Input}, {Area}, {AreaState}, {AlarmType}, {SpecialText}, {AddInfo}
-</code> \\ Templates will be replaced with proper values during sending message. \\ {{.text.png?nolink|}}
-  * Select the users to which you want the message to be sent. \\ {{.smsuser.png?nolink|}}
-  * Save the new definition. {{.save.png?nolink|}} \\ The new template will appear in the definition list. \\ {{.templatesave.png?nolink|}}
-**The new alarm definition is active as soon as it is saved, i.e. immediately.**
-===== Event history =====
-The last part of the application is used to view the generated messages with information whether they have been sent. \\
-{{.history.png?nolink|}}
-To make the search easier we have added filters to each column. \\
-For example, if you want to find alarms containing the text "PIR" you can use the filter in the column Sms text: \\ {{.historyfilter.png?nolink|}}