Last modified by teamwire001 on 2025/08/19 08:19

From version 4.1
edited by teamwire001
on 2025/08/19 08:19
Change comment: DOC-434
To version 1.1
edited by teamwire001
on 2021/06/10 09:56
Change comment: Imported from XAR

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -4. Windows Install Options
1 +3. Silent Installation
Content
... ... @@ -1,221 +1,131 @@
1 -{{id name="4-quietinstall"/}}
2 -
3 -= Quiet installation =
4 -
5 -{{tabs idsToLabels="install1=Desktop 4, install2=Until Desktop 3.4.3"/}}
6 -
7 -(% id="install1" %)
1 +(% class="box warningmessage" %)
8 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.
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 -
13 -
14 -To install the Teamwire app quietly, use the following command and parameters:
15 -
16 -{{code language="none"}}
17 -msiexec.exe /i <path_to_package> /qn
18 -{{/code}}
19 -
20 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" /qn{{/code}}
3 +These features are available on Teamwire for Windows only.
21 21  )))
22 22  
23 -(% id="install2" %)
24 -(((
6 +
25 25  You can install Teamwire in silent mode from a command line to avoid user interaction during the process.
26 26  
27 27  Therefore the command syntax is
28 28  
29 -{{code language="none"}}
11 +{{code language="plain"}}
30 30  start "" /WAIT Teamwire-setup_XXX.exe /S [optional parameters] /D=<path>
31 31  {{/code}}
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.
15 +## ##
34 34  
17 +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.
18 +
35 35  Example:
36 36  
37 -{{code language="none"}}
21 +{{code language="plain"}}
38 38  start "" /WAIT Teamwire-setup_1.10.0.exe /S /D=C:\Program Files (x86)\Teamwire\
39 39  {{/code}}
40 40  
41 -An app shortcut will be created automatically and can be found in the Teamwire software directory.
25 +## ##
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 -
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}}
27 +(% class="box infomessage" %)
28 +(((
29 +Please note, ##/D## must be the **last parameter used** in the command line and **must not contain any quotation marks** even if the path contains spaces.
48 48  )))
49 49  
32 +## ##
50 50  
51 -{{id name="4-installcontext"/}}
34 +An app shortcut will be created automatically and can be found in the Teamwire software directory.
52 52  
53 -== Installation context ==
36 +The shortcut's target for the default installation is {{code language="plain"}}"<app_directory>\Teamwire\nw.exe" "<app_directory>\Teamwire\app"{{/code}}
54 54  
55 -{{tabs idsToLabels="context1=Desktop 4, context2=Until Desktop 3.4.3"/}}
56 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.
39 +{{id name="optional"/}}
60 60  
61 -Windows Installer can install a package on a computer into two installation contexts: per-machine and per-user.
41 += Optional parameters =
62 62  
63 -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"]]
43 +The following parameters are optional and support additional settings to be enabled during the installation.
64 64  
45 +Furthermore, please note that 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.
65 65  
66 -{{id name="4-context-user"/}}
67 67  
68 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Per user installation
69 -
70 -By default, the package is installed in the per-user installation context. The following command performs the per-user installation:
71 -
72 -{{code language="none"}}
73 -msiexec.exe /i <path_to_package>
74 -{{/code}}
75 -
76 -Teamwire will be installed to the following directory: ##%LOCALAPPDATA%\Programs\Teamwire##
77 -
78 -
79 -{{id name="4-context-machine"/}}
80 -
81 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Per machine installation
82 -
83 -To install the package in the per-machine installation context, the ##ALLUSERS## parameter is required. The following command performs the per-machine installation:
84 -
85 -{{code language="none"}}
86 -msiexec.exe /i <path_to_package> ALLUSERS=1
87 -{{/code}}
88 -
89 -Teamwire will be installed to the following directory: ##C:\Program Files\Teamwire##
90 -
91 -
92 -{{id name="4-context-custom"/}}
93 -
94 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Custom installation directory
95 -
96 -You can define a custom directory for the Teamwire app installation with the following parameters:
97 -
98 -{{code language="none"}}
99 -msiexec.exe /i <path_to_package> APPLICATIONFOLDER=<absolute_application_path>
100 -{{/code}}
101 -
102 -Example: {{code language="none"}}msiexec.exe /i "C:\Users\USERNAME\Downloads\teamwire-setup.msi" APPLICATIONFOLDER="C:\Teamwire"{{/code}}
103 -)))
104 -
105 -(% id="context2" %)
106 -(((
107 107  {{id name="roamingdir"/}}
108 108  
109 -(% class="numbox" %)A(%%) (% class="numbox-title" %)Roaming user data directory
50 +== Roaming User Directory ==
110 110  
111 -{{code language="none"}}/APPDATA=TRUE{{/code}} ## ##
52 +{{code language="plain"}}/APPDATA=TRUE{{/code}} ## ##
112 112  
113 -This is an optional parameter.
54 +By default, the user's data is written to the ##%LOCALAPPDATA%## directory ( ##..\AppData\Local\## ).
114 114  
115 -By default, the user's data is written to the ##%LOCALAPPDATA%## directory (##..\AppData\Local\##).
56 +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.
116 116  
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.
118 -
119 119  Example:
120 120  
121 -{{code language="none"}}
60 +{{code language="plain"}}
122 122  start "" /WAIT Teamwire-setup_1.10.0.exe /S /APPDATA=TRUE /D=C:\Program Files (x86)\Teamwire\
123 123  {{/code}}
124 124  
64 +## ##
65 +
125 125  An app shortcut will be created automatically and can be found in the Teamwire software directory.
126 126  
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}}
68 +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}}
128 128  
129 129  
130 130  {{id name="customdir"/}}
131 131  
132 -(% class="numbox" %)B(%%) (% class="numbox-title" %)Custom user data directory
73 +== Custom User Directory ==
133 133  
134 -{{code language="none"}}/USERDATADIR=<path>{{/code}} ## ##
75 +{{code language="plain"}}/USERDATADIR=<path>{{/code}} ## ##
135 135  
136 -This is an optional parameter.
77 +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.**
137 137  
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.**
79 +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.
139 139  
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.
141 -
142 142  Example:
143 143  
144 -{{code language="none"}}
83 +{{code language="plain"}}
145 145  start "" /WAIT Teamwire-setup_1.10.0.exe /S /USERDATADIR="H:\TeamwireData\" /D=C:\Program Files (x86)\Teamwire\
146 146  {{/code}}
147 147  
87 +## ##
88 +
148 148  An app shortcut will be created automatically and can be found in the Teamwire software directory.
149 149  
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}}
91 +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}}
151 151  
152 152  
153 -
154 154  {{id name="runonstartup"/}}
155 155  
156 -(% class="numbox" %)C(%%) (% class="numbox-title" %)Run on startup
96 +== Run on Startup ==
157 157  
158 -{{code language="none"}}/STARTUP=TRUE{{/code}} ## ##
98 +{{code language="plain"}}/STARTUP=TRUE{{/code}} ## ##
159 159  
160 -This is an optional parameter.
161 -
162 162  With this parameter you enable the feature to run Teamwire on Windows startup.
163 163  
164 164  Example:
165 165  
166 -{{code language="none"}}
104 +{{code language="plain"}}
167 167  start "" /WAIT Teamwire-setup_1.10.0.exe /S /STARTUP=TRUE /D=C:\Program Files (x86)\Teamwire\
168 168  {{/code}}
169 -)))
170 170  
108 +## ##
171 171  
172 -{{id name="4-quietdeinstall"/}}
110 +{{id name="silentdeinstall"/}}
111 += Silent Deinstallation =
173 173  
174 -= Quiet deinstallation =
175 -
176 -{{tabs idsToLabels="deinstall1=Desktop 4, deinstall2=Until Desktop 3.4.3"/}}
177 -
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.
181 -
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"]]
183 -
184 -
185 -To deinstall the Teamwire app quietly, use the following command and parameters:
186 -
187 -{{code language="none"}}
188 -msiexec.exe /x <path_to_package> /qn
189 -{{/code}}
190 -
191 -The MSI file path required for the deinstallation depends on your data management.
192 -
193 -
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.
196 -
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 -(((
204 204  You can deinstall Teamwire in silent mode from a command line to avoid user interaction during the process.
205 205  
206 206  Therefore the command syntax is
207 207  
208 -{{code language="none"}}
117 +{{code language="plain"}}
209 209  start "" /WAIT "<path>\uninstall.exe" /S
210 210  {{/code}}
211 211  
212 212  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.**
213 213  
214 -Example: {{code language="none"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
123 +Example: {{code language="plain"}}start "" /WAIT "C:\Program Files (x86)\Teamwire\uninstall.exe" /S{{/code}}
215 215  
216 -{{info}}
125 +
126 +(% class="box infomessage" %)
127 +(((
217 217  Please note, the user data is not being removed for all users but the user performing the local deinstallation.
218 -{{/info}}
219 219  )))
220 220  
221 221  ## ##