Changes for page 6. Logfile

Last modified by teamwire001 on 2025/09/11 15:01

From version 2.2
edited by teamwire001
on 2021/12/03 15:18
Change comment: updated directory info
To version 10.1
edited by teamwire001
on 2025/09/11 15:01
Change comment: Upload new image "desktop4-errorscreen.png", version 1.1

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -5. Logfile
1 +6. Logfile
Content
... ... @@ -1,49 +1,137 @@
1 -Of course we hope you will not run into any issues using Teamwire. Still, if you have found a bug or have troubles using our product, we reckon on your feedback, so we can improve the software.
1 +Of course we hope you will not run into any issues using Teamwire.
2 2  
3 -To provide you with the best support we rely on the information you can give to us when reporting an error. Please send us a detailed description of your experience and a technical error report. Therefore Teamwire creates the following reports:
3 +Still, if you have found a bug or have troubles using our product, we reckon on your feedback, so we can improve the software. To provide you with the best support we rely on the information you can give to us when reporting an error. Please send us a detailed description of your experience and a technical error report.
4 4  
5 +
6 +{{id name="desktop-4-helpcenter"/}}
7 +
8 += Teamwire Help Center =
9 +
10 +{{tabs idsToLabels="helpcenter1=Desktop 4, helpcenter2=Until Desktop 3.4.3"/}}
11 +
12 +(% id="helpcenter1" %)
13 +(((
14 +In case you experience some odd behaviour by Teamwire without getting an error message, you can visit the **Help Center** to obtain your logfiles.
15 +
16 +Open the **drop-down menu** [[image:Public.Applications.Desktop.User-Manual-Desktop4.WebHome@icons-dropdown.svg||height="20"]] next to your name and select **Help Center**. You will find an option called **Download the logfiles and send them to your administrator**. Clicking this option will open your file explorer to export and save an archive file (##.zip##) with the required logs.
17 +
18 +## ##
19 +[[image:desktop4-helpcenter.png||width="75%"]]
20 +## ##
21 +)))
22 +
23 +(% id="helpcenter2" %)
24 +(((
25 +The Help Center is not included in the Desktop version 3.
26 +)))
27 +
28 +(% style="border-color:var(--gili_blue_300)" %)
29 +----
30 +
31 +
32 +{{id name="desktop-4-explorer"/}}
33 +
34 += File explorer =
35 +
36 +{{tabs idsToLabels="fileexplorer1=Desktop 4, fileexplorer2=Until Desktop 3.4.3"/}}
37 +
38 +(% id="fileexplorer1" %)
39 +(((
40 +The logfile can also be obtained manually with your file explorer. Depending on your operating system, the file is stored in different directories as listed below.
41 +
42 +
43 +(% class="lead" id="4-windows" %)
44 +Windows
45 +
46 +On Windows the logfile is stored at ##%LOCALAPPDATA%\teamwire\logs\##
47 +resp. ##C:\Users\USERNAME\AppData\Local\teamwire\logs\##
48 +
49 +
50 +(% class="lead" id="4-macos" %)
51 +macOS
52 +
53 +On macOS the logfile is stored at ##~~/Library/Application Support/teamwire/logs/##
54 +
55 +
56 +(% class="lead" id="4-linux" %)
57 +Linux
58 +
59 +On Linux the logfile is stored at ##~~/.config/teamwire/logs/##
60 +)))
61 +
62 +(% id="fileexplorer2" %)
63 +(((
64 +Teamwire creates the following reports:
65 +
5 5  * **registration_failure.txt**
6 6  This file tracks incidents during the registration routine
7 7  
8 8  * **exceptions.log**
9 -This file tracks low level incidents not caused by the app's code, e.g. file or directoy permissions
70 +This file tracks low level incidents not caused by the app's code, e.g. file or directory permissions
10 10  
11 11  * **log.txt**
12 -This file tracks all high level incidents caused by the app itself
13 -
73 +This file tracks all high-level incidents caused by the app itself
14 14  ## ##
15 15  
16 -(% class="lead" %)
17 -Depending on the desktop's OS, these files are stored in different directories.
76 +Depending on your operating system, the files are stored in different directories as listed below
18 18  
19 -{{id name="windows"/}}
20 20  
21 -= Windows =
79 +(% class="lead" id="windows" %)
80 +Windows
22 22  
23 -|(% style="width:30%" %)**Local user directory** (default)|{{code language="plain"}}%LOCALAPPDATA%\Teamwire\User Data\Default\Logs{{/code}}
24 -e.g.## ## ##C:\Users\USERNAME\AppData\Local\Teamwire\User Data\Default\Logs##
25 -|**Roaming user directory** (##/APPDATA=TRUE##)
26 -[[^^What is that?^^>>doc:Public.Applications.Desktop.Silent-Installation.WebHome||anchor="roamingdir"]]|{{code language="plain"}}%APPDATA%\Teamwire\User Data\Default\Logs{{/code}}
27 -e.g.## ## ##C:\Users\USERNAME\AppData\Roaming\Teamwire\User Data\Default\Logs##
28 -|**Custom user directory** (##/USERDATADIR=<path>##)
29 -[[^^What is that?^^>>doc:Public.Applications.Desktop.Silent-Installation.WebHome||anchor="customdir"]]|{{code language="plain"}}<path>\Teamwire\User Data\Default\Logs{{/code}}
30 -e.g.## ## ##H:\Installations\Teamwire\User Data\Default\Logs##
82 +|**Local user directory** (default)|##%LOCALAPPDATA%\Teamwire\User Data\Default\Logs##
83 +resp. ##C:\Users\USERNAME\AppData\Local\Teamwire\User Data\Default\Logs##
84 +|**[[Roaming user directory>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="roamingdir"]]**|##%APPDATA%\Teamwire\User Data\Default\Logs##
85 +resp. ##C:\Users\USERNAME\AppData\Roaming\Teamwire\User Data\Default\Logs##
86 +|**[[Custom user directory>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="customdir"]]**|##<path>\Teamwire\User Data\Default\Logs##
87 +e.g. ##H:\Installations\Teamwire\User Data\Default\Logs##
88 +|(% style="width:20%" %) |
31 31  
32 -{{id name="macos"/}}
90 +(% class="lead" id="macos" %)
91 +macOS
33 33  
34 -= macOS =
93 +On macOS the logfiles are always stored to ##~~/Library/Application Support/Teamwire/Default/Logs##
35 35  
36 -On macOS the logfiles are always stored to
37 37  
38 -{{code language="plain"}}/Library/Application Support/Teamwire/Default/Logs{{/code}} ## ##
96 +(% class="lead" id="linux" %)
97 +Linux
39 39  
99 +On Linux the logfiles are always stored to ##~~/.config/Teamwire/Default/Logs##
100 +)))
40 40  
41 -{{id name="linux"/}}
102 +(% style="border-color:var(--gili_blue_300)" %)
103 +----
42 42  
43 -= Linux =
44 44  
45 -On Linux the logfiles are always stored to
106 +{{id name="desktop-4-error"/}}
46 46  
47 -{{code language="plain"}}/.config/Teamwire/Default/Logs{{/code}} ## ##
108 += In the error screen =
48 48  
110 +{{tabs idsToLabels="errorscreen1=Desktop 4, errorscreen2=Until Desktop 3.4.3"/}}
111 +
112 +(% id="errorscreen1" %)
113 +(((
114 +When running into a problem, Teamwire will show an error message and block your app interface.
115 +
116 +This screen provides an option to **Download the logfiles and send them to your administrator**.
117 +
118 +Clicking this option will open your file explorer to save an archive file (##.zip##) with the required logs. The file tracks all
119 +
120 +* incidents during the registration routine.
121 +* high level incidents caused by the app itself.
122 +* low level incidents not caused by the app's code, e.g. file or directory permissions.
123 +
49 49  ## ##
125 +[[image:desktop4-errorscreen.png||width="75%"]]
126 +## ##
127 +)))
128 +
129 +(% id="errorscreen2" %)
130 +(((
131 +The error message screen is not included in the Desktop version 3.
132 +)))
133 +
134 +(% style="border-color:var(--gili_blue_300)" %)
135 +----
136 +
137 +## ##
desktop4-de-helpcenter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teamwire001
Size
... ... @@ -1,0 +1,1 @@
1 +266.2 KB
Content
desktop4-errorscreen.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teamwire001
Size
... ... @@ -1,0 +1,1 @@
1 +56.3 KB
Content
desktop4-helpcenter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teamwire001
Size
... ... @@ -1,0 +1,1 @@
1 +173.7 KB
Content