Changes for page 6. Logfile

Last modified by teamwire001 on 2024/12/12 15:28

From version 1.1
edited by teamwire001
on 2021/06/10 09:56
Change comment: Imported from XAR
To version 8.2
edited by teamwire001
on 2024/12/12 15:28
Change comment: fix icon

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -5. Logfile
1 +6. Logfile
Content
... ... @@ -1,49 +1,117 @@
1 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.
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 +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 -* {{code}}registration_failure.txt{{/code}} for issues during the registration process and
6 -* {{code}}log.txt{{/code}} for critical errors
7 7  
8 -Depending on the platform, these files are stored in different directories.
6 +{{id name="desktop-4"/}}
9 9  
8 += Desktop 4.0.0 or newer =
10 10  
11 -= Windows =
12 12  
13 -When storing the user data into the **local user data directory (default):**
11 +{{id name="desktop-4-error"/}}
14 14  
15 -{{code language="plain"}}
16 -%LOCALAPPDATA%\Teamwire\User Data\Default\
17 -{{/code}}
13 +== On error screen ==
18 18  
19 -resp. {{code language="plain"}}C:\Users\USERNAME\AppData\Local\Teamwire\User Data\Default\{{/code}}
15 +When running into a problem, Teamwire will show an error message and block your app interface.
20 20  
17 +This screen provides an option to **Download the logfiles and send them to your administrator**. Clicking this option will open your file explorer to save an archive file (.zip) with the required logs. The file tracks all
18 +
19 +* incidents during the registration routine
20 +* high level incidents caused by the app itself
21 +* low level incidents not caused by the app's code, e.g. file or directory permissions
21 21  ## ##
22 22  
23 -When storing the user data into the **roaming directory** ( ##/APPDATA=TRUE## ):
24 +{{id name="desktop-4-helpcenter"/}}
24 24  
25 -{{code language="plain"}}
26 -%APPDATA%\Teamwire\User Data\Default\
27 -{{/code}}
26 +== Via Help Center ==
28 28  
29 -resp. {{code language="plain"}}C:\Users\USERNAME\AppData\Roaming\Teamwire\User Data\Default\{{/code}}
28 +In case you experience some odd behaviour by Teamwire without getting an error message, you can visit the **Help Center** to obtain your logfiles.
30 30  
30 +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 save an archive file (.zip) with the required logs.
31 +
31 31  ## ##
33 +[[image:desktop4-helpcenter.png||width="75%"]]
34 +## ##
32 32  
33 -Or any directory you have set for ##/USERDATADIR## during the [[Silent Installation process>>doc:Public.Applications.Desktop.Silent-Installation.WebHome||anchor="HCustomUserDirectory"]].
36 +{{id name="desktop-4-explorer"/}}
34 34  
38 +== Via file explorer ==
35 35  
36 -= macOS =
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.
37 37  
38 -{{code language="plain"}}
39 -/Library/Application Support/Teamwire/Default/
40 -{{/code}}
41 41  
43 +(% class="lead" id="4-windows" %)
44 +Windows
42 42  
43 -= Linux =
46 +On Windows the logfile is stored at
44 44  
45 -{{code language="plain"}}
46 -/.config/Teamwire/Default/
47 -{{/code}}
48 +|(% style="width:20%" %)**Desktop 4.0.16 or newer**|{{code language="plain"}}%LOCALAPPDATA%\teamwire\logs\logs.log{{/code}}
49 +e.g. C:\Users\USERNAME\AppData\Local\teamwire\logs\logs.log
50 +|**Desktop 4.0.15 and previous versions**|{{code language="plain"}}%APPDATA%\teamwire\logs\logs.log{{/code}}
51 +e.g. C:\Users\USERNAME\AppData\Roaming\teamwire\logs\logs.log
52 +## ##
48 48  
54 +(% class="lead" id="4-macos" %)
55 +macOS
56 +
57 +On macOS the logfile is stored at
58 +
59 +{{code language="plain"}}~/Library/Application Support/teamwire/logs/logs.log{{/code}} ## ##
60 +
61 +
62 +(% class="lead" id="4-linux" %)
63 +Linux
64 +
65 +On Linux the logfile is stored at
66 +
67 +{{code language="plain"}}~/.config/teamwire/logs/logs.log{{/code}} ## ##
68 +
69 +
70 +{{id name="desktop-previous"/}}
71 +
72 += Desktop 3.4.3 and previous versions =
73 +
74 +Teamwire creates the following reports:
75 +
76 +* **registration_failure.txt**
77 +This file tracks incidents during the registration routine
78 +
79 +* **exceptions.log**
80 +This file tracks low level incidents not caused by the app's code, e.g. file or directory permissions
81 +
82 +* **log.txt**
83 +This file tracks all high-level incidents caused by the app itself
49 49  ## ##
85 +
86 +Depending on your operating system, the files are stored in different directories as listed below
87 +
88 +
89 +(% class="lead" id="windows" %)
90 +Windows
91 +
92 +|(% style="width:20%" %)**Local user directory** (default)|{{code language="plain"}}%LOCALAPPDATA%\Teamwire\User Data\Default\Logs{{/code}}
93 +e.g. C:\Users\USERNAME\AppData\Local\Teamwire\User Data\Default\Logs
94 +|**Roaming user directory**
95 +[[^^What is that?^^>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="roamingdir"]]|{{code language="plain"}}%APPDATA%\Teamwire\User Data\Default\Logs{{/code}}
96 +e.g. C:\Users\USERNAME\AppData\Roaming\Teamwire\User Data\Default\Logs
97 +|**Custom user directory**
98 +[[^^What is that?^^>>doc:Public.Applications.Desktop.Windows-Install-Options.WebHome||anchor="customdir"]]|{{code language="plain"}}<path>\Teamwire\User Data\Default\Logs{{/code}}
99 +e.g. H:\Installations\Teamwire\User Data\Default\Logs
100 +## ##
101 +
102 +(% class="lead" id="macos" %)
103 +macOS
104 +
105 +On macOS the logfiles are always stored to
106 +
107 +{{code language="plain"}}~/Library/Application Support/Teamwire/Default/Logs{{/code}} ## ##
108 +
109 +
110 +(% class="lead" id="linux" %)
111 +Linux
112 +
113 +On Linux the logfiles are always stored to
114 +
115 +{{code language="plain"}}~/.config/Teamwire/Default/Logs{{/code}} ## ##
116 +
117 +## ##
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