Wiki source code of Nachrichten

Last modified by YellowFox_RD on 2025/01/23 13:18
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 = Basics =
9
10 == Which functions does the message management provide? ==
11
12 The message management provides sending and receiving text messages from and to cars equipped with a display. Besides simple text messages it is also possible to send response messages, where the driver has to confirm the receipt or answer an forced choice question.
13
14 == Available lists ==
15
16 After starting the messages management there will be visible the sent messages by default. Other states and functions will be available by switching the tabs. The upper tab bar offers the following options:
17
18 (((
19 * [[sent messages>>doc:||anchor="Nachrichten-sentMessages"]]
20 * [[not delivered messages>>doc:||anchor="Nachrichten-notDeliveredMessages"]]
21 * [[received messages>>doc:||anchor="Nachrichten-receivedMessages"]]
22 * [[message pool>>doc:||anchor="Nachrichten-messageDrafts"]]
23 * [[search>>doc:||anchor="Nachrichten-searchMessages"]]
24 * [[settings>>doc:||anchor="Nachrichten-Settings"]]
25 )))
26
27 = The tabs =
28
29 == Common list structure ==
30
31 Above each list will be placed some buttons. They provide functionality to refresh the current list, create a new message and (re)send or delete the previously selected messages.
32
33 |[[image:reload.png]]|//refresh//|Reloads the current list.
34 |[[image:new_message.png]]|//create new message//|Opens the window to create a new message.
35 |[[image:send_selected_message.png]]|//(re)send selected messages//|Sends the selected messages to the according car display. If no car assigned to a message draft, there will be shown a list, to assign the cars.
36 |[[image:del_selected_message.png]]|//delete selected messages//|Attention, this deletes the messages with the according state entries from the website permanently
37
38 Depending on your setup the list contains a number of entries per page. The count of entries can be changed temporary directly at the table head or permanently by changing personal settings. Additionally there will be a search field on the upper right to filter the messages by the columns: sender, car, message state and message text. An ascending or descending ordering per column is also available.
39 The following columns are available:
40
41 |//message created on//|date and time when a message was created
42 |//sender//|name of the person, who created the message
43 |//car//|the car, received the message
44 |//message state//|last state message send by car (not available for message pool list)
45 |//message text//|the text of the message
46 |//action//|(((
47 * [[image:magnifier.png]] shows the message details with according state history
48 * [[image:advancedsettings.png]] Only available at message pool. Allows edit of current message.
49 * [[image:duplicate_message.png]] Creates a copy of the current message to send with same or similar data.
50 * [[image:response.png]] Only for received messages available. Opens the menu to create a new message with current car preselected.
51 )))
52
53 == Available lists ==
54
55 |//send messages {{id name="Nachrichten-sentMessages"/}}//|Here are listed all messages, sent from protal to a car. If the message is a canned response message, the answer will be visible too.
56 |//not delivered messages {{id name="Nachrichten-notDeliveredMessages"/}}//|The messages in this list, shall be send to a car but the reception is not confirmed or was rejected. Some minutes of delay until the confirmation is received by the portal are totally normal.
57 |//received messages {{id name="Nachrichten-receivedMessages"/}}//|It is possible to create a new message directly at the car display. This messages are located here.
58 |//message pool {{id name="Nachrichten-messageDrafts"/}}//|If a message just was created without sending, it will be shown here. Such messages don't need a car assignment, can be edited and send in groups.
59 |//search {{id name="Nachrichten-searchMessages"/}}//|The search allows to define filters upon all available messages. Compared to the regular search field it is possible to define what you want very precisely. (look at extra paragraph: ' [[The search>>doc:/display/ds/Nachrichten||anchor="Nachrichten-Thesearch"]]' )
60
61 For all lists except search list, the the count of messages at the list is always visible in the tab list. The tabs except the search tab only considering the data of the latest 2 months. To work with older data you can use the search tab and limit the results by date and state.
62
63 == The search ==
64
65 On switch to search tab there will be the limitation to the last 30 days of creation active. To search for the filtered data there will be a search button between input area and result list.
66 The following search filters are available:
67 //create date//, //state date//, //message text//, //car(s)//, //message state// and //user//
68 The first two parameters are time spans. You can select a predefined timespan from the list or you can define the date range yourself. If a date was set, the filter can be removed with the x ([[image:cross.png]]) behind each field.
69 All other input fields can handle multiple search terms for filtering. For cars the selection is similar to the create/edit dialog. In all other input fields the filter parameters will be shown as tokens. A token can be set by pressing enter. Each of this tokens can be deleted seperately. A message will be found, if one of the tokens for a filter will fit and all of the filters will fit.
70
71 = Create/copy/edit message =
72
73 After clicking //create new message// ([[image:new_message.png]]) the input mask will be opened. The input masks to edit, answer or copy a message similar but with prepoulated data, so the following points apply to all cases.
74
75 |//cars//|A message can be send to one or multiple cars. If you only want to select one car, just select it from the list. To specify multiple cars or groups use the first option //select multiple cars//. This opens a dialog where you can click the desired cars. To directly send a new message you have to select at least one car.
76 |//response selection//|Selecting a car with a Garmin display you can predefine responses for the driver. The following response types are available:(((
77 * //confirmation message//: The driver must confirm the message after reading it, so it is documented, that he read an important message.
78 * //yes/no message//: The driver has to decide whether he confirms a message with yes or no.
79 * //message with predefined responses//: Depending on display configuration with available response messages you can define which of these responses are appended to the message.
80 )))
81 |//message text//|The regular plain message text. The available length differs by display type so you can see the count of available chars directly below the text box.
82 |//Cancel//|Cancels the input and return to the last overview list.
83 |//create message / save changes//|saves the message draft and return to message pool list
84 |//send message//|If at least one car is defined, it is possible to send the message directly. You should see this message then in sent messages list.
85
86 = Chat =
87
88 The chat is an alternate view compared to the other submodules. Basically the assignment of messages and vehicles was changed here. Instead of an overview of all messages of one type for all vehicles here the conversation per vehicle is shown.
89 There are 2 main areas. On the left is the foldable vehicles list, showing for each vehicle the following informations:
90
91 (((
92 * vehicle sign
93 * ignition state
94 * time and place of latest gps message
95 * count of unread messages, send from the vehicle
96 * optional: the currently logged on driver
97 )))
98
99 The search on top of this list allows to limit the visible vehicles.
100 The main area itself is divided horizontal as followed:
101
102 (((
103 * top row(((
104 * optional: the currently selected vehicle
105 * a free text search for all messages of the currently selected vehicle
106 * the icon to open the chat in a new seperate window
107 )))
108
109 * center area(((
110 * the list with messages itself
111 )))
112
113 * bottom row(((
114 * the input area for the message text
115 * optional: selectable predefined responses
116 * send message icon
117 * optional: if a predefined response selected, the selected values
118 )))
119 )))
120
121 messages list
122 Each message will be displayed in an independent bubble. Each bubble is marked to divide messages from portal, rti interface and vehicle. Messages created using the portal showing the portal user, who wrote the message. For messages from vehicles the logged on driver at the vehicle is visible, if there was no driver was logged on, the vehicle sign will be shown.
123 The messages are ordered from oldest to newest one with the newest message visible at bottom position on init. To load older messages, scroll to the top of the list. The list will be refreshed periodically in background, so new messages from vehicles or any other protal user will be added with a little delay automatically.
124 If a predefined response option selected for the message, the response type and selected answer is visible below the message text. By clicking there, the other available responses sent to the display will be faded in. 
125 On the bottom right edge of each message bubble the send date and the send state will be shown. A Click at the date field will expand the message history details with all state changes For each change there will be added the user, if possible. Additionally the following sending state icons are defined:
126
127 |[[image:sending_unsent.png]]|sending the message to the server
128 |[[image:sending_sent.png]]|the message was successfully sent to the server
129 |[[image:sending_received.png]]|the message was successfully send to the vehicle display
130 |[[image:sending_read.png]]|the message was read by the driver
131 |[[image:send_failed.png]]|sending the message failed
132
133 = Settings{{id name="Nachrichten-Settings"/}} =
134
135 Depending on used hardware and user rights there are different submenus available.
136
137 |//personal settings//|always available with the following options:(((
138 * set the default count of table rows at lists
139 * enable playing a sound on incoming new messages (may not work in all browsers)
140 )))
141 |//tab settings//|Here you can set which tabs are available on top and influence the sequence. The administrator can set a profile to be active for the whole company and additionally lock the change of this setting for regular users.
142 |//display settings//|Here you can set up to 8 message texts as draft available at car display. If you are using garmin displays, you can also set a selection of predefined message response texts. The response texts for each message can be defined on create. After changing texts it is neccessary to send the new configuration to your cars. You can set this texts only for cars, where you have the corresponding edit right.
143