Wiki source code of Alarmmanager

Last modified by YellowFox_RD on 2025/01/23 11:06
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 The alarm manager makes it possible to get immediately informed about certain messages of your car. The use of this module depends on the portal right alarm manager. You need at least the right //see// to use the module.
9
10 = Alarm messages =
11
12 The alarm manager supports a bunch of different messages. Principally we distinct in messages about eventuating events and not eventuating events. An example for a eventuating event is a set telemetry input which gets active unexpectedly. A not-eventuating alarm in contrast might inform you about a vehicle which did not once enter the company area during the last 24 hours.
13 The following alarm messages are supported by alarm manager:
14
15 == Alarms about eventuating Events ==
16
17 |=Messagetype|=Description
18 |movement message / Selfgeofence|//Will be triggered, if the vehicle leaves its [[Selfgeofence>>doc:YellowFox Standard Portal.Verwaltung.Fahrzeugbezogene Einstellungen.Ortung.WebHome]] resp. an active movement messager is warning.//
19 |overspeed|//Will be triggered, if the vehicle is faster than a in[[ object settings>>doc:YellowFox Remote Tracking Interface.Funktionen.Fahrzeugeinstellungen.WebHome]] set treshold.//
20 |idle|//Will be triggered, if the ignition is on but vehicle is not moving or very slow.//
21 |missing driver authentication|//Will be triggered, if the vehicle is moving without a registered driver.//
22 |removing / fixing of the box in the retainer|//Will be triggered, if the box is removed resp. fixed in its retainer.//
23 |box start|//Will be triggered, if the box is started.//
24 |temperature value|//Will be triggered, if the temperature sensors are exceeding a in [[object settings>>doc:YellowFox Remote Tracking Interface.Funktionen.Fahrzeugeinstellungen.WebHome]] set treshold.//
25 |missing on-board power supply|//Will be triggered, if the box is losing its on-board power supply, for example because the battery is low.//
26 |regain of on-board power supply|//Will be triggered, if the box regains its on-board power supply.//
27 |YellowPad alarm|//Will be triggered, if a as alarm set button on the YellowPad is pressed.//
28 |telemetry message|//Will be triggered, if a telemetry input sends a message about a specific status change.//
29 |area message|//Will be triggered, if the vehicle enters or leaves a specific area.//
30 |wrong trailer|//Will be triggered, if the workflow of the tour notices that the vehicle is connected to another trailer than stated in the tour.//
31 //You need to have unlocked tour management  to use this. Then you are able to create workflows which include the condition "trailer check". If this kind of workflow notices that the wrong trailer is connected, it will trigger this alarm.//
32
33 == Alarms about not eventuating events ==
34
35 |=Messagetype|=Description
36 |missing location message|//Will be triggered, if during a set time range no location message was registered in the portal.//
37 |invalid GPS|//Will be triggered, if during a set time range no valid GPS signal was registered.//
38 |missing telemetry message|//Will be triggered, if during a set time range a defined status change of a specific telemetry input was not registered.//
39 |missing area message|//Will be triggered, if during a set time range the vehicle did not enter a specific area.//
40
41 = Alarm events =
42
43 In alarm events you can display past, but also open alarms. By using different filter options you are able to research events.
44 The menu on the top offers the following functions:
45
46 |=(% colspan="3" %)Controls
47 |[[image:reload.png]]|//Reload//|reloads the table data
48 |[[image:icon_delete.png]]|//delete selected//|deletes all selected events
49 |[[image:activate_selected_alarm.png]]|//confirm delected//|confirms all selected events
50
51 In the table you can see all available alarm events. By default the events of the last 2 month are displayed. By using the filter menu you can filter by a specific car, another timerange, a specific alarm profile or the status of the event. Furthermore you can use the free text search to look for buzz words.
52 For a single alarm event you can also see the time it was triggered, the triggering vehicle, the corresponding alarm profile, the history and status. The history might be expandable by clicking on  [[image:empty_arrow_down.png]]. On top the action menu offers the following functions:
53
54 |=(% colspan="3" %)actions
55 |[[image:image2020-7-3_8-7-27.png]]|//show event details//|shows the details of the event in a separate pop-up
56 |[[image:image2020-7-3_8-7-31.png]]|//show profile details//|shows the details of the corresponding alarm profile in a separate pop-up
57 |[[image:image2020-7-3_8-7-43.png]]|//show on map//|show the position of the vehicle at the time the event was triggered (not always available)
58 |[[image:image2020-7-3_8-7-58.png]]|//delete alarm event//|deletes this event
59 |[[image:image2020-7-3_8-12-34.png]]|//confirm alarm event//|only for open events: confirms this event
60
61 If you open the pop-up for event details you have also the possibility to export this event as PDF.
62 To use the actions for //deleting// and //confirming// events, you have to have at least the portal right //alarm manager confirm//.  
63 Alarm events will be deleted automatically after 180 days.
64
65 = Alarm profiles =
66
67 In alarm profiles you can administrate your individual alarm profiles.
68 You are able to display the profiles in two views: profile based or vehicle based.
69 In profile-based view the profile is leading in the table. You can see at first glance, which vehicles were assigned to a profile, which message type is selected and if the profile is currently active. On top the action menu offers the following functions:
70
71 |=(% colspan="3" %)actions
72 |[[image:image2020-7-3_8-18-3.png]]|//edit alarm profile//|opens the editor for this profile
73 |[[image:image2020-7-3_8-18-33.png]]|//show details//|shows the details of this alarm profile in a separate pop-up
74 |[[image:image2020-7-3_8-19-8.png]]|//(de-)activate alarm profile//|based on the current status you can change it here
75 |[[image:image2020-7-3_8-20-32.png]]|//delete alarm profile//|deletes this profile including all assignments and events
76
77 To use the functions //delete, (de-)activate// and //edit//, you have to have at least the portal right //alarm manager edit//.
78
79 In vehicle-based view the vehicle is in focus. Here you can easily see, which profiles are assigned to a specific vehicle and if they are active. Please notice that profiles can only be (de-)activated globally. The status of a profile is the same on every vehicle. The action menu on the right also offers the following functions:
80
81 |=(% colspan="3" %)actions
82 |[[image:image2020-7-3_8-22-55.png]]|//edit assignments//|Shows all current assignments in a pop-up. You can edit or delete them.
83 |[[image:image2020-7-3_8-19-8.png]]|//copy assignments//|copy all assignments of a vehicle to another
84 //Attention: the old assignments of this vehicle will be overwritten!//
85 |[[image:image2020-7-3_8-20-32.png]]|//delete assignments//|deletes all assignments of this car
86
87 To administrate assignments, you have to have at least the portal right //alarm manager edit//.
88 By using the menu on the top you also have the following functions available:
89
90 |=(% colspan="3" %)controls
91 |[[image:reload.png]]|//reload//|reload table data
92 |[[image:new_alarm.png]]|//create new alarm profile//|opens the assistent to create a new alarm profile
93 |[[image:deactivate_selected_alarm.png]]|//deactivate selected alarm profiles //|all selected profiles will be set to inactive
94 |[[image:activate_selected_alarm.png]]|//activate selected alarm profiles //|all selected profiles will be set to active
95
96 Besides reload, these functions are only available, if you have the portal right //alarm manager edit//.
97
98 = Create new alarm =
99
100 To create a new alarm profile, click on the corresponding icon on the top of alarm profile view. A new dialog will open. This function is only available, if you have the portal right //alarm manager edit//.
101
102 == Step 1: Set message type ==
103
104 In first step you will be asked to set a name for your new alarm profile and choose a message type. You have to choose first if you want to create an eventuating or not-eventuating alarm. Afterwards all available message types will be displayed. Please notice, that you can only choose from message types which are compatible with your fleet. You can only choose one message type per alarm profile.
105
106 === Choose area ===
107
108 If you have chosen an area alarm, you will be asked to choose an area next. You can choose either all areas or only one specific area. We distinct by box-based und server-based areas. Server-based areas are marked with (server) behind their name. These areas are compatible with all boxes which deliver GPS values. Box-based areas are not supported by all boxes.
109 Both area types must be assigned to a vehicle first, before an alarm can be triggered. If you have chosen a single area, the dialog will do this for you after you have chosen the vehicles in step 3. If you have chosen all area you will only get a hint to do this by yourself. This is because there are restrictions in assigning areas to vehicles. Based on the boxtype only a specific amount of box-based areas can be assigned. Server-based areas can be assigned without limits.
110
111 === Choose telemetry input ===
112
113 If you have chosen a telemetry alarm, you will be asked to choose telemetry inputs next. You can decide for each input from 1 to 7 if it is relevant or not and if you want to notice the input getting active, inactive or both. After you have chosen an input from the dropdown, you can check by clicking on //show vehicles with input[ x ] //which vehicles are using this input and how it is named there.
114
115 == Step 2: Set alarm time ==
116
117 In the next step you can set when you alarm profile should be active. 
118 If you are creating an eventuating alarm, you can set the time spans per day. Decide first which days are relevant at all by clicking the checkbox on the left. Afterwards you can set the time span. You can either create a single time span (like from 7 a.m. to 1 p.m.) or a splitted time range (like from 12 a.m. to 3 a.m. and 10 p.m. to 12 p.m.). Splitted time spans always have to start at 12 a.m. and end at 12 p.m. To change the mode click on [[image:image2020-7-3_8-40-51.png]] right next to the time slider.
119
120 If you have chosen a not-eventuating alarm, you only have to set the evaluation time. You can also choose on which days the alarm should be evaluated. You can set the time for each day separately. Afterwards you need to choose a time span which should be evaluated retrospectively from your set time. This time span is the same for each day of the week.
121
122 == Step 3: Choose vehicles ==
123
124 In this step you can choose which vehicles should be assigned to the profile initially. You change this setting later on, so you might skip it now. 
125 All vehicles will be displayed. Vehicles which are disabled are not compatible to your chosen profile configuration and can therefore not be selected.
126 If you have chosen an area alarm for a box-based area, vehicles which are not assigned to this area, but also do not have space for more areas, are also disabled.
127 If you have chosen a telemetry alarm, after each vehicle the input names will be displayed.
128
129 After confirming your selection, you configuration will be evaluated. If you have chosen an area alarm for a single area, it has to be assigned to the vehicles at this point. For a telemetry alarm it will be checked, if all chosen vehicles use all chosen telemetry inputs or only a few. You might get a hint if not all inputs are used. You can skip these cars or assign nevertheless.
130
131 == Step 4: Notifications ==
132
133 In the step notifications you can set how you want to be informed in case of a triggered alarm event.
134 A triggered event will be displayed in the portal by default. Furthermore you can decide if you want to get a mail and/or a sms. Mark your desired options by clicking the checkboxes on the left. Afterwards you need to enter your contact infos and a message text. You can set 3 recipients per option on max. **Please notice that sms will produce additional costs!**
135 In second part of settings for notifications you are able to set more details. A triggered alarm event can be renewed periodically during the first 24 hours. After these the alarm will still remain open in the portal, but you will not get new messages. Alternatively you can quit the alarm by default right after triggering. This will also set it to confirmed.
136 Furthermore you can decide, if the alarm should only be triggered if the GPS signal has a minimum quality. This might be useful for area alarms. Due to your vehicle being in a tunnel or a hangar, the position message might drift - this could lead to an alarm being triggered to early.
137 On top of that you can decide if your alarm should only be active inside or outside of an area. If you are already creating an area alarm, this settings has not many use cases. But you could for example model a crossing between two areas or exclude a smaller area with two overlapping areas.
138
139 == Done ==
140
141 By clicking on Save and End your profile will be saved and the selected vehicle assignments will be created. You have the possibility to reload the dialog afterwards to create a new alarm profile or close it.
142
143 = Settings =
144
145 Here you can manage your settings regarding the alarm profile and alarm event view.
146 For both modules you can set, how many rows should be displayed on module start. Confirm your selection by clicking save.
147