1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>User Import/Export Plugin Readme</title>
<style type="text/css">
/* global font and body settings */
body {
font-size : 100%;
background-color : #d3d6d9;
padding: 0px;
margin: 0px 0px 30px 0px;
}
body, td, th {
font-family : arial, helvetica, sans-serif;
font-size : 10pt;
}
pre, tt, code {
font-family : courier new, monospaced;
font-size : 9pt;
}
#pageContainer {
display: block;
position: relative;
clear: both;
background-color: #fff;
border: 1px solid #999;
padding: 40px;
margin: 30px;
-moz-border-radius: 6px;
}
#pageHeader {
display: block;
position: relative;
height: 80px;
background-color: #e7eaee;
border: 1px solid #cccccc;
border-bottom: none;
-moz-border-radius: 5px 5px 0px 0px;
margin: 10px 0px 0px 0px;
}
#pageBody {
margin: 0px 18px 0px 20px;
}
/* anchors */
a:link {
color: #11568c;
}
a:visited {
color: #571c8d;
}
a:hover {
color: #7a1d42;
text-decoration : underline;
}
a:active {
color: #7a1d42;
}
/* page header elements (logo and navigation) */
.navigation {
display: block;
position: relative;
height: 20px;
background-color: #335588;
border: 1px solid #cccccc;
border-top: none;
color: #ffffff;
font-size: 11px;
line-height: 18px;
padding: 0px 0px 0px 0px;
margin: 0px 0px 25px 0px;
overflow: hidden;
}
.navigation a {
margin: 0px 20px 0px 20px;
}
.navigation a:link { color: #ffffff; }
.navigation a:visited { color: #ffffff; }
.navigation a:hover { color: #ffffff; }
.navigation a:active { color: #ffffff; }
/* headings */
h1 {
display: block;
position: relative;
font-size : 1.7em;
font-weight : bold;
color: #670e15;
padding: 0px;
margin: 30px 0px 0px 20px;
}
h2 {
font-size : 1.3em;
font-weight : bold;
margin: 40px 0px 6px 0px;
padding: 0px;
color: #335588;
}
h3 {
font-size : 1.0em;
font-weight : bold;
margin: 25px 0px 3px 0px;
padding: 0px;
color: #334466;
}
/* general elements */
p {
margin: 0px 0px 15px 0px;
}
ul {
margin: 5px 0px 15px 35px;
}
li {
padding-bottom : 4px;
}
tt {
font-family : courier new;
font-weight : bold;
color : #060;
}
hr {
display: block;
height: 1px;
background-color: #999999;
border: none;
margin: 40px 0px 20px 0px;
}
.footer {
font-size : 8pt;
color : #666;
text-align : center;
margin-top : 2em;
padding-top : 0.5em;
border-top : 1px #CCC solid;
}
.datatable TH {
color : #fff;
background-color : #2A448C;
text-align : left;
}
.datatable TD {
background-color : #FAF6EF;
}
.datatable .name {
background-color : #DCE2F5;
text-align : center;
}
.xmltable TD {
background-color : #EFEFEF;
}
</style>
</head>
<body>
<div id="pageContainer">
<div id="pageHeader">
<h1>User Import/Export Plugin Readme</h1>
</div>
<div id="pageBody">
<h2>Overview</h2>
<p>The user import/export plugin provides a way to import and export Wildfire user data via
the Admin Console. The user data consists of jid (aka "username"), name, email address, password
and roster list (aka "buddy list"). This plugin also can aid in the migration of users from other
Jabber/XMPP based systems to Wildfire.</p>
<h2>Installation</h2>
<p>Copy the userImportExport.jar into the plugins directory of your Wildfire installation.
The plugin will then be automatically deployed. To upgrade to a new version, copy the new
userImportExport.jar file over the existing file.</p>
<h2>Configuration</h2>
<p>Presently, there is nothing that can be configured for the user import/export plugin.</p>
<h2>Using the Plugin</h2>
<p>The plugin is accessed via the "User Import & Export" sidebar item located under the
"Users/Groups" tab in the Admin Console. Note: if you are using LDAP as your user data source the
following message will appear: "Sorry, because you are using LDAP as your user store this plugin
will not work with your Wildfire installation."
<li><b>Importing</b> - Select the "Import User Data" option from the user import/export selection
page. On the import page, use the "Browse" button to locate the file that contains the user
information you want to locate and then click on the "Import" button. If the plugin is successful
in importing all user data, you will be presented with the message: "All users added successfully".
If the plugin was not successful in importing all user data you, will receive a message indicating
what might have gone wrong. If during the import process, the plugin detects that you are trying to
import a user that already exists in the system, it will not import that user or any roster
information.</li>
<br>
<li><b>Exporting</b> - Select the "Export User Data" option from the user import/export selection
page. User data can be exported either to a file or directly to the screen. To export to a file,
select the "To File" radio button, enter the name you want your export file to be called in the
"Export File Name" and then click on the "Export" button. Note: the plugin will automatically append
an ".xml" extension to the file name if it is not already present. To export to the screen, select
the "To Screen" radio button and then click on the "Export" button. The user data will be placed in
the provided text area.</li>
<br>
<li><b>Migration</b> - To import user data from another instant messaging system using the plugin,
the import file must conform to the wildfire-user-schema.xsd.xml schema file (located in the classes
directory of the userImportExport.jar). When importing a user data file the plugin will first validate
the file against the schema file." If the plugin cannot validate the import file the user data will
not be imported. During the import process the plugin gives you the ability to update user roster
entries domain names to server name of your Wildfire installation. For example, say you have a user
whose roster looks like:
</li>
<br>
<div class="xmltable">
<table>
<tr>
<td>
<User><br>
<Username>mike</Username><br>
<Password>iamcool</Password><br>
<Email>mike@mike.com</Email><br>
<Name>Mike Jones</Name><br>
<CreationDate>1125442154664</CreationDate><br>
<ModifiedDate>1125442154664</ModifiedDate><br>
<Roster><br>
<Item jid="jane@im.olddomain.net" askstatus="-1" recvstatus="-1" substatus="3" name="Jane"><br>
<Group></Group><br>
</Item><br>
<Item jid="paul@xyz.net" askstatus="-1" recvstatus="-1" substatus="3" name="Paul"><br>
<Group></Group><br>
</Item><br>
</Roster><br>
</User><br>
</td>
</tr>
</table>
</div>
<br>
Mike and Jane's accounts both reside on server whose domain name is "im.olddomain.net" and are being
imported to a Wildfire installation whose server name is "im.newdomain.net". If on the import screen
the "Optional Existing Domain" field is filled in with "im.olddomain.net" (without the quotes) any
roster item jid that contains "im.olddomain.net" will be replaced with "im.newdomain.net". So, in
effect, the import file would be transformed to look like:
<br>
<br>
<div class="xmltable">
<table>
<tr>
<td>
<User><br>
<Username>mike</Username><br>
<Password>iamcool</Password><br>
<Email>mike@mike.com</Email><br>
<Name>Mike Jones</Name><br>
<CreationDate>1125442154664</CreationDate><br>
<ModifiedDate>1125442154664</ModifiedDate><br>
<Roster><br>
<Item jid="jane@im.newdomain.net" askstatus="-1" recvstatus="-1" substatus="3" name="Jane"><br>
<Group></Group><br>
</Item><br>
<Item jid="paul@xyz.net" askstatus="-1" recvstatus="-1" substatus="3" name="Paul"><br>
<Group></Group><br>
</Item><br>
</Roster><br>
</User><br>
</td>
</tr>
</table>
</div>
<br>
<br>
Below is a sample of an exported user list from Wildfire than contains two users, Joe and Sally, who
have added each other to their respective rosters.
<br>
<br>
<div class="xmltable">
<table>
<tr>
<td>
<?xml version="1.0" encoding="UTF-8"?><br>
<br>
<Wildfire><br>
<User><br>
<Username>joe</Username><br>
<Password>joepwd</Password><br>
<Email></Email><br>
<Name></Name><br>
<CreationDate>1125601449177</CreationDate><br>
<ModifiedDate>1125601449177</ModifiedDate><br>
<Roster><br>
<Item jid="sally@localhost" askstatus="-1" recvstatus="-1" substatus="3" name="Sally"><br>
<Group/><br>
</Item><br>
</Roster><br>
</User><br>
<User><br>
<Username>sally</Username><br>
<Password>sallypwd</Password><br>
<Email></Email><br>
<Name></Name><br>
<CreationDate>1125601471848</CreationDate><br>
<ModifiedDate>1125601471848</ModifiedDate><br>
<Roster><br>
<Item jid="joe@localhost" askstatus="-1" recvstatus="-1" substatus="3"><br>
<Group/><br>
</Item><br>
</Roster><br>
</User><br>
</Wildfire><br>
</td>
</tr>
</table>
</div>
<br>
<br>
Below is a list of the different status types and what their associated numbers mean.
<br>
<br>
<div class="datatable">
<table cellpadding="3" cellspacing="1" border="0" width="700">
<thead>
<tr>
<th colspan="2">askstatus</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name">-1</td>
<td>The roster item has no pending subscripton requests.</td>
</tr>
<tr>
<td class="name">0</td>
<td>The roster item has been asked for permission to subscribe to their presence but no
response has been received.</td>
</tr>
<tr>
<td class="name">1</td>
<td>The roster owner has asked to the roster item to unsubscribe from it's presence but
has not received confirmation.</td>
</tr>
</tbody>
</table>
<br>
<table cellpadding="3" cellspacing="1" border="0" width="700">
<thead>
<tr>
<th colspan="2">recvstatus</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name">-1</td>
<td>There are no subscriptions that have been received but not presented to the user.</td>
</tr>
<tr>
<td class="name">1</td>
<td>The server has received a subscribe request, but has not forwarded it to the user.</td>
</tr>
<tr>
<td class="name">2</td>
<td>The server has received an unsubscribe request, but has not forwarded it to the user.</td>
</tr>
</tbody>
</table>
<br>
<table cellpadding="3" cellspacing="1" border="0" width="700">
<thead>
<tr>
<th colspan="2">substatus</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name">-1</td>
<td>Indicates the roster item should be removed.</td>
</tr>
<tr>
<td class="name">0</td>
<td>No subscription is established.</td>
</tr>
<tr>
<td class="name">1</td>
<td>The roster owner has a subscription to the roster item's presence.</td>
</tr>
<tr>
<td class="name">2</td>
<td>The roster item has a subscription to the roster owner's presence.</td>
</tr>
<tr>
<td class="name">3</td>
<td>The roster item and owner have a mutual subscription.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>