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

Summary

Details

Page properties
Content
... ... @@ -1,54 +1,63 @@
1 -= Desktop 4.0.0 or newer =
1 +{{id name="4-quietinstall"/}}
2 2  
3 += Quiet installation =
3 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}}.
5 +{{tabs idsToLabels="install1=Desktop 4, install2=Until Desktop 3.4.3"/}}
5 5  
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"]].
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.
7 7  
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"]]
8 8  
9 -{{id name="4-quietinstall"/}}
10 10  
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 -
16 16  To install the Teamwire app quietly, use the following command and parameters:
17 17  
18 -{{code language="shell"}}
16 +{{code language="none"}}
19 19  msiexec.exe /i <path_to_package> /qn
20 20  {{/code}}
21 21  
22 -Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
20 +Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
21 +)))
23 23  
23 +(% id="install2" %)
24 +(((
25 +You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
24 24  
25 -{{id name="4-quietdeinstall"/}}
27 +Therefore the command syntax is
26 26  
27 -== Quiet deinstallation ==
29 +{{code language="none"}}
30 +start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
31 +{{/code}}
28 28  
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"]]
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.
30 30  
35 +Example:
31 31  
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
37 +{{code language="none"}}
38 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
36 36  {{/code}}
37 37  
38 -The MSI file path required for the deinstallation depends on your data management.
41 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
39 39  
43 +The shortcut's target for the default installation is {{code language="none"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
40 40  
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.
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 +)))
43 43  
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##.
46 46  
47 -
48 48  {{id name="4-installcontext"/}}
49 49  
50 50  == Installation context ==
51 51  
55 +{{tabs idsToLabels="context1=Desktop 4, context2=Until Desktop 3.4.3"/}}
56 +
57 +(% id="context1" %)
58 +(((
59 +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.
60 +
52 52  Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
53 53  
54 54  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"]]
... ... @@ -56,11 +56,11 @@
56 56  
57 57  {{id name="4-context-user"/}}
58 58  
59 -=== Per user ===
68 +(% class="numbox" %)A(%%) (% class="numbox-title" %)Per user installation
60 60  
61 61  By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
62 62  
63 -{{code language="shell"}}
72 +{{code language="none"}}
64 64  msiexec.exe /i <path_to_package>
65 65  {{/code}}
66 66  
... ... @@ -69,11 +69,11 @@
69 69  
70 70  {{id name="4-context-machine"/}}
71 71  
72 -=== Per machine ===
81 +(% class="numbox" %)B(%%) (% class="numbox-title" %)Per machine installation
73 73  
74 74  To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:
75 75  
76 -{{code language="shell"}}
85 +{{code language="none"}}
77 77  msiexec.exe /i <path_to_package> ALLUSERS=1
78 78  {{/code}}
79 79  
... ... @@ -82,139 +82,131 @@
82 82  
83 83  {{id name="4-context-custom"/}}
84 84  
85 -=== Custom installation directory ===
94 +(% class="numbox" %)C(%%) (% class="numbox-title" %)Custom installation directory
86 86  
87 87  You can define a custom directory for the Teamwire app installation with the following parameters:
88 88  
89 -{{code language="shell"}}
98 +{{code language="none"}}
90 90  msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
91 91  {{/code}}
92 92  
93 -Example: {{code language="shell"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
102 +Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
103 +)))
94 94  
105 +(% id="context2" %)
106 +(((
107 +{{id name="roamingdir"/}}
95 95  
109 +(% class="numbox" %)A(%%) (% class="numbox-title" %)Roaming user data directory
96 96  
97 -----
111 +{{code language="none"}}/APPDATA=TRUE{{/code}} ## ##
98 98  
99 -{{id name="desktop-previous"/}}
113 +This is an optional parameter.
100 100  
101 -= Desktop 3.4.3 and previous versions =
115 +By default, the user's data is written to the ##%LOCALAPPDATA%## directory (##..\AppData\Local\##).
102 102  
117 +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.
103 103  
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 -
118 118  Example:
119 119  
120 -{{code language="plain"}}
121 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
121 +{{code language="none"}}
122 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
122 122  {{/code}}
123 123  
124 124  An app shortcut will be created automatically and can be found in the Teamwire software directory.
125 125  
126 -The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
127 +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}}
127 127  
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  
130 +{{id name="customdir"/}}
133 133  
134 -{{id name="roamingdir"/}}
132 +(% class="numbox" %)B(%%) (% class="numbox-title" %)Custom user data directory
135 135  
136 -=== Roaming user directory ===
134 +{{code language="none"}}/USERDATADIR=<path>{{/code}} ## ##
137 137  
138 -{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
139 -
140 140  This is an optional parameter.
141 141  
142 -By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
138 +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.**
143 143  
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.
140 +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.
145 145  
146 146  Example:
147 147  
148 -{{code language="plain"}}
149 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
144 +{{code language="none"}}
145 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
150 150  {{/code}}
151 151  
152 152  An app shortcut will be created automatically and can be found in the Teamwire software directory.
153 153  
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}}
150 +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}}
155 155  
156 156  
157 -{{id name="customdir"/}}
158 158  
159 -=== Custom user directory ===
154 +{{id name="runonstartup"/}}
160 160  
161 -{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
156 +(% class="numbox" %)C(%%) (% class="numbox-title" %)Run on startup
162 162  
158 +{{code language="none"}}/STARTUP=TRUE{{/code}} ## ##
159 +
163 163  This is an optional parameter.
164 164  
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.**
162 +With this parameter you enable the feature to run Teamwire on Windows startup.
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 -
169 169  Example:
170 170  
171 -{{code language="plain"}}
172 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
166 +{{code language="none"}}
167 +start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
173 173  {{/code}}
169 +)))
174 174  
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}}
172 +{{id name="4-quietdeinstall"/}}
178 178  
174 += Quiet deinstallation =
179 179  
180 -{{id name="runonstartup"/}}
176 +{{tabs idsToLabels="deinstall1=Desktop 4, deinstall2=Until Desktop 3.4.3"/}}
181 181  
182 -=== Run on startup ===
178 +(% id="deinstall1" %)
179 +(((
180 +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.
183 183  
184 -{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
182 +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"]]
185 185  
186 -This is an optional parameter.
187 187  
188 -With this parameter you enable the feature to run Teamwire on Windows startup.
185 +To deinstall the Teamwire app quietly, use the following command and parameters:
189 189  
190 -Example:
191 -
192 -{{code language="plain"}}
193 -start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
187 +{{code language="none"}}
188 +msiexec.exe /x <path_to_package> /qn
194 194  {{/code}}
195 195  
196 -## ##
191 +The MSI file path required for the deinstallation depends on your data management.
197 197  
198 -{{id name="silentdeinstall"/}}
199 199  
200 -== Silent deinstallation ==
194 +**Example A:** {{code language="none"}}msiexec.exe /x "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
195 +The file which was also used during the installation has remained in its directory.
201 201  
197 +
198 +**Example B:** {{code language="none"}}msiexec.exe /x "C:\Windows\Installer\34237a6a.msi" /qn{{/code}}
199 +You use the MSI file cached by the system. By default, it's stored under ##%SystemRoot%\Installer##.
200 +)))
201 +
202 +(% id="deinstall2" %)
203 +(((
202 202  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
203 203  
204 204  Therefore the command syntax is
205 205  
206 -{{code language="plain"}}
208 +{{code language="none"}}
207 207  start "" /WAIT "<path>\uninstall.exe" /S
208 208  {{/code}}
209 209  
210 210  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.**
211 211  
212 -Example: {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
214 +Example: {{code language="none"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
213 213  
214 -
215 -(% class="box infomessage" %)
216 -(((
216 +{{info}}
217 217  Please note, the user data is not being removed for all users but the user performing the local deinstallation.
218 +{{/info}}
218 218  )))
219 219  
220 220  ## ##