Skip to Content
Last modified by teamwire001 on 2025/09/11 14:59
From version 4.2
edited by teamwire001
on 2025/09/11 14:59
Change comment: DOC-434
To version 3.1
edited by teamwire001
on 2024/12/12 14:44
Change comment: DOC-390 + heading hierarchy fixes

Summary

Details

Page properties
Content
... ... @@ -1,54 +1,48 @@
1 -{{id name="4-quietinstall"/}}
1 += Desktop 4.0.0 or newer =
2 2  
3 -= Quiet installation =
4 4  
5 -{{tabs idsToLabels="install1=Desktop 4, install2=Until Desktop 3.4.3"/}}
4 +Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code}}msiexec{{/code}}.
6 6  
7 -(% id="install1" %)
8 -(((
9 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
6 +This command can be used, for example, to install Teamwire without any user interaction in [[quiet mode>>doc:||anchor="4-quietinstall"]]. Or to define the [[installation contexts>>doc:||anchor="4-installcontext"]].
10 10  
11 -The {{code language="none"}}msiexec{{/code}} **display options** allow a quiet installation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]
12 12  
9 +{{id name="4-quietinstall"/}}
13 13  
11 +== Quiet installation ==
12 +
13 +The {{code}}msiexec{{/code}} **display options** allow a quiet installation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]
14 +
15 +
14 14  To install the Teamwire app quietly, use the following command and parameters:
15 15  
16 -{{code language="none"}}
18 +{{code language="shell"}}
17 17  msiexec.exe /i <path_to_package> /qn
18 18  {{/code}}
19 19  
20 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
21 -)))
22 +Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
22 22  
23 -(% id="install2" %)
24 -(((
25 -You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
26 26  
27 -Therefore the command syntax is
25 +{{id name="4-quietdeinstall"/}}
28 28  
29 -{{code language="none"}}
30 -start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
31 -{{/code}}
27 +== Quiet deinstallation ==
32 32  
33 -Please enter the path to the Teamwire setup file and use the option ##/D## to define a directory in which Teamwire is going to install its further contents.
29 +The {{code}}msiexec{{/code}} **display options** allow a quiet deinstallation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]
34 34  
35 -Example:
36 36  
37 -{{code language="none"}}
38 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
32 +To deinstall the Teamwire app quietly, use the following command and parameters:
33 +
34 +{{code language="shell"}}
35 +msiexec.exe /x <path_to_package> /qn
39 39  {{/code}}
40 40  
41 -An app shortcut will be created automatically and can be found in the Teamwire software directory.
38 +The MSI file path required for the deinstallation depends on your data management.
42 42  
43 -The shortcut's target for the default installation is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
44 44  
45 -{{info}}
46 -Please note, the ##/D## option must be the **last parameter used** in the command line and **must not contain any quotation marks** even if the path contains spaces.
47 -{{/info}}
48 -)))
41 +Example A: {{code language="shell"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
42 +The file which was also used during the installation has remained in its directory.
49 49  
50 -(% style="border-color:var(--gili_blue_300)" %)
51 -----
44 +Example B: {{code language="shell"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
45 +You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
52 52  
53 53  
54 54  {{id name="4-installcontext"/}}
... ... @@ -55,12 +55,6 @@
55 55  
56 56  == Installation context ==
57 57  
58 -{{tabs idsToLabels="context1=Desktop 4, context2=Until Desktop 3.4.3"/}}
59 -
60 -(% id="context1" %)
61 -(((
62 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
63 -
64 64  Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
65 65  
66 66  A per-machine installation of the package is required to enable **all users** of the computer to access and use the application. Because a per-machine installation makes changes to the system that affect all users, administrative permissions are required. Further information available here: [[Microsoft ~> Windows Installer ~> Installation context>>https://learn.microsoft.com/en-us/windows/win32/msi/installation-context||rel="noopener noreferrer" target="_blank"]]
... ... @@ -68,11 +68,11 @@
68 68  
69 69  {{id name="4-context-user"/}}
70 70  
71 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Per user installation
59 +=== Per user ===
72 72  
73 73  By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
74 74  
75 -{{code language="none"}}
63 +{{code language="shell"}}
76 76  msiexec.exe /i <path_to_package>
77 77  {{/code}}
78 78  
... ... @@ -81,11 +81,11 @@
81 81  
82 82  {{id name="4-context-machine"/}}
83 83  
84 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Per machine installation
72 +=== Per machine ===
85 85  
86 86  To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:
87 87  
88 -{{code language="none"}}
76 +{{code language="shell"}}
89 89  msiexec.exe /i <path_to_package> ALLUSERS=1
90 90  {{/code}}
91 91  
... ... @@ -94,137 +94,139 @@
94 94  
95 95  {{id name="4-context-custom"/}}
96 96  
97 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Custom installation directory
85 +=== Custom installation directory ===
98 98  
99 99  You can define a custom directory for the Teamwire app installation with the following parameters:
100 100  
101 -{{code language="none"}}
89 +{{code language="shell"}}
102 102  msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
103 103  {{/code}}
104 104  
105 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
106 -)))
93 +Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
107 107  
108 -(% id="context2" %)
109 -(((
110 -{{id name="roamingdir"/}}
111 111  
112 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Roaming user data directory
113 113  
114 -{{code language="none"}}/APPDATA=TRUE{{/code}} ## ##
97 +----
115 115  
116 -This is an optional parameter.
99 +{{id name="desktop-previous"/}}
117 117  
118 -By default, the user's data is written to the ##%LOCALAPPDATA%## directory (##..\AppData\Local\##).
101 += Desktop 3.4.3 and previous versions =
119 119  
120 -In some corporate and virtual environments, a folder's content is deleted when the session is closed. In order to write into ##%APPDATA%## directory (##..\AppData\Roaming\##), please add the ##/APPDATA=TRUE## argument to your command.
121 121  
104 +{{id name="quietinstall"/}}
105 +
106 +== Quiet installation ==
107 +
108 +You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
109 +
110 +Therefore the command syntax is
111 +
112 +{{code language="plain"}}
113 +start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
114 +{{/code}}
115 +
116 +Please enter the path to the Teamwire setup file and use the option ##/D## to define a directory in which Teamwire is going to install its further contents.
117 +
122 122  Example:
123 123  
124 -{{code language="none"}}
125 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
120 +{{code language="plain"}}
121 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
126 126  {{/code}}
127 127  
128 128  An app shortcut will be created automatically and can be found in the Teamwire software directory.
129 129  
130 -The shortcut's target incl. the roaming directory is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir=%APPDATA%/Teamwire{{/code}}
126 +The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
131 131  
128 +(% class="box infomessage" %)
129 +(((
130 +Please note, the ##/D## option must be the **last parameter used** in the command line and **must not contain any quotation marks** even if the path contains spaces.
131 +)))
132 132  
133 -{{id name="customdir"/}}
134 134  
135 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Custom user data directory
134 +{{id name="roamingdir"/}}
136 136  
137 -{{code language="none"}}/USERDATADIR=<path>{{/code}} ## ##
136 +=== Roaming user directory ===
138 138  
138 +{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
139 +
139 139  This is an optional parameter.
140 140  
141 -In case you need to store your user data to a different location due to your network environment or retention policies for local data, you are able to define a custom path (e.g. mapped home directory for your users) with the parameter ##/USERDATADIR##. **You will have to put the path in quotation marks.**
142 +By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
142 142  
143 -The customised directories will not be created until the first run and registration. Please note, that despite the custom path of user data the original directories (##%LOCALAPPDATA%\Teamwire\User Data\Default\##) will still be created but do not contain any data.
144 +In some corporate and virtual environments, a folder's content is deleted when the session is closed. In order to write into ##%APPDATA%## directory ( ##..\AppData\Roaming\## ) , please add the ##/APPDATA=TRUE## argument to your command.
144 144  
145 145  Example:
146 146  
147 -{{code language="none"}}
148 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
148 +{{code language="plain"}}
149 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
149 149  {{/code}}
150 150  
151 151  An app shortcut will be created automatically and can be found in the Teamwire software directory.
152 152  
153 -The shortcut's target incl. the customised directory is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir="<userdata_directory>\Teamwire"{{/code}}
154 +The shortcut's target incl. the roaming directory is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir=%APPDATA%/Teamwire{{/code}}
154 154  
155 155  
157 +{{id name="customdir"/}}
156 156  
157 -{{id name="runonstartup"/}}
159 +=== Custom user directory ===
158 158  
159 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Run on startup
161 +{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
160 160  
161 -{{code language="none"}}/STARTUP=TRUE{{/code}} ## ##
162 -
163 163  This is an optional parameter.
164 164  
165 -With this parameter you enable the feature to run Teamwire on Windows startup.
165 +In case you need to store your user data to a different location due to your network environment or retention policies for local data, you are able to define a custom path (e.g. mapped home directory for your users) with the parameter ##/USERDATADIR##. **You will have to put the path in quotation marks.**
166 166  
167 +The customised directories will not be created until the first run and registration. Please note, that despite the custom path of user data the original directories ( ##%LOCALAPPDATA%\Teamwire\User Data\Default\## ) will still be created but do not contain any data.
168 +
167 167  Example:
168 168  
169 -{{code language="none"}}
170 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
171 +{{code language="plain"}}
172 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
171 171  {{/code}}
172 -)))
173 173  
174 -(% style="border-color:var(--gili_blue_300)" %)
175 -----
175 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
176 176  
177 +The shortcut's target incl. the customised directory is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app" --user-data-dir="<userdata_directory>\Teamwire"{{/code}}
177 177  
178 -{{id name="4-quietdeinstall"/}}
179 179  
180 -= Quiet deinstallation =
180 +{{id name="runonstartup"/}}
181 181  
182 -{{tabs idsToLabels="deinstall1=Desktop 4, deinstall2=Until Desktop 3.4.3"/}}
182 +=== Run on startup ===
183 183  
184 -(% id="deinstall1" %)
185 -(((
186 -Microsoft Windows Installer is an installation and configuration service provided with Windows. It allows to run processes with the Windows command {{code language="none"}}msiexec{{/code}} without any user interaction.
184 +{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
187 187  
188 -The {{code language="none"}}msiexec{{/code}} **display options** allow a quiet deinstallation. All available parameters can be found here: [[Microsoft ~> msiexec ~> Display options>>url:https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec#display-options||rel="noopener noreferrer" target="_blank"]]
186 +This is an optional parameter.
189 189  
188 +With this parameter you enable the feature to run Teamwire on Windows startup.
190 190  
191 -To deinstall the Teamwire app quietly, use the following command and parameters:
190 +Example:
192 192  
193 -{{code language="none"}}
194 -msiexec.exe /x <path_to_package> /qn
192 +{{code language="plain"}}
193 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
195 195  {{/code}}
196 196  
197 -The MSI file path required for the deinstallation depends on your data management.
196 +## ##
198 198  
198 +{{id name="silentdeinstall"/}}
199 199  
200 -**Example A:** {{code language="none"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
201 -The file which was also used during the installation has remained in its directory.
200 +== Silent deinstallation ==
202 202  
203 -
204 -**Example B:** {{code language="none"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
205 -You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
206 -)))
207 -
208 -(% id="deinstall2" %)
209 -(((
210 210  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
211 211  
212 212  Therefore the command syntax is
213 213  
214 -{{code language="none"}}
206 +{{code language="plain"}}
215 215  start "" /WAIT "<path>\uninstall.exe" /S
216 216  {{/code}}
217 217  
218 218  Enter the path to the uninstalling file, which is located in the Teamwire root directory. **You will have to put the path in quotation marks.**
219 219  
220 -Example: {{code language="none"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
212 +Example: {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
221 221  
222 -{{info}}
214 +
215 +(% class="box infomessage" %)
216 +(((
223 223  Please note, the user data is not being removed for all users but the user performing the local deinstallation.
224 -{{/info}}
225 225  )))
226 226  
227 -(% style="border-color:var(--gili_blue_300)" %)
228 -----
229 -
230 230  ## ##