Changes for page 6. Logfile

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

From version 5.1
edited by teamwire001
on 2024/12/04 13:01
Change comment: DOC-389
To version 9.1
edited by teamwire001
on 2025/09/11 15:01
Change comment: DOC-434

Summary

Details

Page properties
Content
... ... @@ -1,62 +1,66 @@
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.
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 5  
6 -= Desktop 4.0.0 or newer =
6 +{{id name="desktop-4-helpcenter"/}}
7 7  
8 -Teamwire creates the logfile **logs.log** which is located in the directories listed below.
8 += Teamwire Help Center =
9 9  
10 -The file tracks all
10 +{{tabs idsToLabels="helpcenter1=Desktop 4, helpcenter2=Until Desktop 3.4.3"/}}
11 11  
12 -* incidents during the registration routine
13 -* high level incidents caused by the app itself
14 -* low level incidents not caused by the app's code, e.g. file or directoy permissions
15 -## ##
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.
16 16  
17 -(% class="lead" %)
18 -Depending on the desktop's OS, the file is stored in a different directory.
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.
19 19  
20 -{{id name="4-windows"/}}
18 +## ##
19 +[[image:desktop4-helpcenter.png||width="75%"]]
20 +## ##
21 +)))
21 21  
22 -== Windows ==
23 +(% id="helpcenter2" %)
24 +(((
25 +The Help Center is not included in the Desktop version 3.
26 +)))
23 23  
24 -On Windows the logfile is stored to
28 +(% style="border-color:var(--gili_blue_300)" %)
29 +----
25 25  
26 -**Up from version 4.0.16**
27 27  
28 -{{code language="plain"}}%LOCALAPPDATA%\teamwire\logs{{/code}} ## ##
29 -e.g. C:\Users\USERNAME\AppData\Local\teamwire\logs
32 +{{id name="desktop-4-explorer"/}}
30 30  
31 -**Until version 4.0.15**
34 += File explorer =
32 32  
33 -{{code language="plain"}}%APPDATA%\teamwire\logs{{/code}} ## ##
34 -e.g. C:\Users\USERNAME\AppData\Roaming\teamwire\logs
36 +{{tabs idsToLabels="fileexplorer1=Desktop 4, fileexplorer2=Until Desktop 3.4.3"/}}
35 35  
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.
36 36  
37 -{{id name="4-macos"/}}
38 38  
39 -== macOS ==
43 +(% class="lead" id="4-windows" %)
44 +Windows
40 40  
41 -On macOS the logfile is stored to
46 +On Windows the logfile is stored at ##%LOCALAPPDATA%\teamwire\logs\##
47 +resp. ##C:\Users\USERNAME\AppData\Local\teamwire\logs\##
42 42  
43 -{{code language="plain"}}~/Library/Application Support/teamwire/logs{{/code}} ## ##
44 44  
50 +(% class="lead" id="4-macos" %)
51 +macOS
45 45  
46 -{{id name="4-linux"/}}
53 +On macOS the logfile is stored at ##~~/Library/Application Support/teamwire/logs/##
47 47  
48 -== Linux ==
49 49  
50 -On Linux the logfile is stored to
56 +(% class="lead" id="4-linux" %)
57 +Linux
51 51  
52 -{{code language="plain"}}~/.config/teamwire/logs{{/code}} ## ##
59 +On Linux the logfile is stored at ##~~/.config/teamwire/logs/##
60 +)))
53 53  
54 -----
55 -
56 -{{id name="desktop-previous"/}}
57 -
58 -= Until Desktop 3.4.3 =
59 -
62 +(% id="fileexplorer2" %)
63 +(((
60 60  Teamwire creates the following reports:
61 61  
62 62  * **registration_failure.txt**
... ... @@ -63,43 +63,71 @@
63 63  This file tracks incidents during the registration routine
64 64  
65 65  * **exceptions.log**
66 -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
67 67  
68 68  * **log.txt**
69 -This file tracks all high level incidents caused by the app itself
73 +This file tracks all high-level incidents caused by the app itself
70 70  ## ##
71 71  
72 -(% class="lead" %)
73 -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
74 74  
75 -{{id name="windows"/}}
76 76  
77 -== Windows ==
79 +(% class="lead" id="windows" %)
80 +Windows
78 78  
79 -|(% style="width:20%" %)**Local user directory** (default)|{{code language="plain"}}%LOCALAPPDATA%\Teamwire\User Data\Default\Logs{{/code}}
80 -e.g. C:\Users\USERNAME\AppData\Local\Teamwire\User Data\Default\Logs
81 -|**Roaming user directory**
82 -[[^^What is that?^^>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="roamingdir"]]|{{code language="plain"}}%APPDATA%\Teamwire\User Data\Default\Logs{{/code}}
83 -e.g. C:\Users\USERNAME\AppData\Roaming\Teamwire\User Data\Default\Logs
84 -|**Custom user directory**
85 -[[^^What is that?^^>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="customdir"]]|{{code language="plain"}}<path>\Teamwire\User Data\Default\Logs{{/code}}
86 -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%" %) |
87 87  
88 -{{id name="macos"/}}
90 +(% class="lead" id="macos" %)
91 +macOS
89 89  
90 -== macOS ==
93 +On macOS the logfiles are always stored to ##~~/Library/Application Support/Teamwire/Default/Logs##
91 91  
92 -On macOS the logfiles are always stored to
93 93  
94 -{{code language="plain"}}~/Library/Application Support/Teamwire/Default/Logs{{/code}} ## ##
96 +(% class="lead" id="linux" %)
97 +Linux
95 95  
99 +On Linux the logfiles are always stored to ##~~/.config/Teamwire/Default/Logs##
100 +)))
96 96  
97 -{{id name="linux"/}}
102 +(% style="border-color:var(--gili_blue_300)" %)
103 +----
98 98  
99 -== Linux ==
100 100  
101 -On Linux the logfiles are always stored to
106 +{{id name="desktop-4-error"/}}
102 102  
103 -{{code language="plain"}}~/.config/Teamwire/Default/Logs{{/code}} ## ##
108 += In the error screen =
104 104  
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 +
105 105  ## ##
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-helpcenter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.teamwire001
Size
... ... @@ -1,0 +1,1 @@
1 +173.7 KB
Content