readme.html 12.8 KB
Newer Older
Ryan Graham's avatar
Ryan Graham committed
1 2 3 4
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
5 6
<title>User Import/Export Plugin Readme</title>
<style type="text/css">
Matt Tucker's avatar
Matt Tucker committed
7 8
   /* global font and body settings */
body {
9 10 11 12
   font-size : 100%;
   background-color : #d3d6d9;
   padding: 0px;
   margin: 0px 0px 30px 0px;
Matt Tucker's avatar
Matt Tucker committed
13 14
}
body, td, th {
15 16
   font-family : arial, helvetica, sans-serif;
   font-size : 10pt;
Matt Tucker's avatar
Matt Tucker committed
17 18
}
pre, tt, code {
19 20
   font-family : courier new, monospaced;
   font-size : 9pt;
Matt Tucker's avatar
Matt Tucker committed
21 22
}
#pageContainer {
23 24 25 26 27 28 29 30
   display: block;
   position: relative;
   clear: both;
   background-color: #fff;
   border: 1px solid #999;
   padding: 40px;
   margin: 30px;
   -moz-border-radius: 6px;
Matt Tucker's avatar
Matt Tucker committed
31 32
}
#pageHeader {
33 34 35 36 37 38 39 40
   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;
Matt Tucker's avatar
Matt Tucker committed
41 42
}
#pageBody {
43
   margin: 0px 18px 0px 20px;
Matt Tucker's avatar
Matt Tucker committed
44
}
45

Matt Tucker's avatar
Matt Tucker committed
46 47
/* anchors */
a:link {
48
   color: #11568c;
Matt Tucker's avatar
Matt Tucker committed
49 50
}
a:visited {
51
   color: #571c8d;
Matt Tucker's avatar
Matt Tucker committed
52 53
}
a:hover {
54 55
   color: #7a1d42;
   text-decoration : underline;
Matt Tucker's avatar
Matt Tucker committed
56 57
}
a:active {
58
   color: #7a1d42;
Matt Tucker's avatar
Matt Tucker committed
59 60 61 62
}

/* page header elements (logo and navigation) */
.navigation {
63 64 65 66 67 68 69 70 71 72 73 74
   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;
Matt Tucker's avatar
Matt Tucker committed
75 76
}
.navigation a {
77
   margin: 0px 20px 0px 20px;
Matt Tucker's avatar
Matt Tucker committed
78 79 80 81 82 83 84 85
}
.navigation a:link { color: #ffffff; }
.navigation a:visited { color: #ffffff; }
.navigation a:hover { color: #ffffff; }
.navigation a:active { color: #ffffff; }

/* headings */
h1 {
86 87 88 89 90 91 92
   display: block;
   position: relative;
   font-size : 1.7em;
   font-weight : bold;
   color: #670e15;
   padding: 0px;
   margin: 30px 0px 0px 20px;
Matt Tucker's avatar
Matt Tucker committed
93 94
}
h2 {
95 96 97 98 99
   font-size : 1.3em;
   font-weight : bold;
   margin: 40px 0px 6px 0px;
   padding: 0px;
   color: #335588;
Matt Tucker's avatar
Matt Tucker committed
100 101
}
h3 {
102 103 104 105 106
   font-size : 1.0em;
   font-weight : bold;
   margin: 25px 0px 3px 0px;
   padding: 0px;
   color: #334466;
Matt Tucker's avatar
Matt Tucker committed
107 108 109 110
}

/* general elements */
p {
111
   margin: 0px 0px 15px 0px;
Matt Tucker's avatar
Matt Tucker committed
112 113 114
}

ul {
115
   margin: 5px 0px 15px 35px;
Matt Tucker's avatar
Matt Tucker committed
116 117
}
li {
118
   padding-bottom : 4px;
Matt Tucker's avatar
Matt Tucker committed
119 120
}
tt {
121 122 123
   font-family : courier new;
   font-weight : bold;
   color : #060;
Matt Tucker's avatar
Matt Tucker committed
124 125
}
hr {
126 127 128 129 130
   display: block;
   height: 1px;
   background-color: #999999;
   border: none;
   margin: 40px 0px 20px 0px;
Matt Tucker's avatar
Matt Tucker committed
131 132 133
}

.footer {
134 135 136 137 138 139
   font-size : 8pt;
   color : #666;
   text-align : center;
   margin-top : 2em;
   padding-top : 0.5em;
   border-top : 1px #CCC solid;
Matt Tucker's avatar
Matt Tucker committed
140 141
}

Matt Tucker's avatar
Matt Tucker committed
142
.datatable TH {
143 144 145
   color : #fff;
   background-color : #2A448C;
   text-align : left;
Matt Tucker's avatar
Matt Tucker committed
146 147
}

Matt Tucker's avatar
Matt Tucker committed
148
.datatable TD {
149
   background-color : #FAF6EF;
Matt Tucker's avatar
Matt Tucker committed
150 151
}

Matt Tucker's avatar
Matt Tucker committed
152
.datatable .name {
153 154
   background-color : #DCE2F5;
   text-align : center;
Matt Tucker's avatar
Matt Tucker committed
155 156
}

Matt Tucker's avatar
Matt Tucker committed
157
.xmltable TD {
158
   background-color : #EFEFEF;
Matt Tucker's avatar
Matt Tucker committed
159
}
160
</style>
Ryan Graham's avatar
Ryan Graham committed
161 162 163
</head>
<body>

Matt Tucker's avatar
Matt Tucker committed
164 165
<div id="pageContainer">

166 167 168
   <div id="pageHeader">
      <h1>User Import/Export Plugin Readme</h1>
   </div>
Matt Tucker's avatar
Matt Tucker committed
169
<div id="pageBody">
Ryan Graham's avatar
Ryan Graham committed
170 171

<h2>Overview</h2>
172
<p>The user import/export plugin provides a way to import and export Openfire user data via
173 174
the Admin Console. The user data consists of username, password, name, email address, creation 
and modified date, and roster list (aka "buddy list"). This plugin also can aid in the migration 
175
of users from other Jabber/XMPP based systems to Openfire.</p>
Ryan Graham's avatar
Ryan Graham committed
176 177

<h2>Installation</h2>
178
<p>Copy the userImportExport.jar into the plugins directory of your Openfire installation.
179 180
The plugin will then be automatically deployed. To upgrade to a new version, copy the new 
userImportExport.jar file over the existing file.</p>
Ryan Graham's avatar
Ryan Graham committed
181 182 183 184 185

<h2>Configuration</h2>
<p>Presently, there is nothing that can be configured for the user import/export plugin.</p>

<h2>Using the Plugin</h2>
186
<p>The plugin is accessed via the "User Import & Export" sidebar item located under the 
187 188 189 190 191 192 193
"Users/Groups" tab in the Admin Console. Note: if you are using a read-only user store such as LDAP
or POP3 this plugin will still work with two caveats:
<ol>
<li>When exporting, the username will be placed in the password element.
<li>When importing, no new users will be created but if the user exists in the user store thier roster will be loaded.
</ol> 
<li><strong>Importing</strong> - Select the "Import User Data" option from the user import/export selection 
194 195 196 197 198 199
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 
200
information, except in the case of using a read-only user store.</li>
201
<br>
202
<li><strong>Exporting</strong> - Select the "Export User Data" option from the user import/export selection 
203 204
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 
205
"Export File Name" and then click on the "Export" button. Note: the plugin will automatically append 
206 207
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 
208
the provided text area.</li>
209
<br>
210
<li><strong>Migration</strong> - To import user data from another instant messaging system using the plugin,
211
the import file must conform to the openfire-user-schema.xsd.xml schema file (located in the classes
212
directory of the userImportExport.jar). When importing a user data file the plugin will first validate 
213
the file against the schema file. If the plugin cannot validate the import file the user data will 
214
not be imported. During the import process the plugin gives you the ability to update user roster 
215
entries domain names to server name of your Openfire installation. For example, say you have a user
216 217 218
whose roster looks like:
</li>

219
<p>
Matt Tucker's avatar
Matt Tucker committed
220
<div class="xmltable">
221 222 223 224 225 226 227 228 229 230 231 232
<table>
<tr>
<td>
&lt;User&gt;<br>
&nbsp;&nbsp;&lt;Username&gt;mike&lt;/Username&gt;<br>
&nbsp;&nbsp;&lt;Password&gt;iamcool&lt;/Password&gt;<br>
&nbsp;&nbsp;&lt;Email&gt;mike@mike.com&lt;/Email&gt;<br>
&nbsp;&nbsp;&lt;Name&gt;Mike Jones&lt;/Name&gt;<br>
&nbsp;&nbsp;&lt;CreationDate&gt;1125442154664&lt;/CreationDate&gt;<br>
&nbsp;&nbsp;&lt;ModifiedDate&gt;1125442154664&lt;/ModifiedDate&gt;<br>
&nbsp;&nbsp;&lt;Roster&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;jane@im.olddomain.net&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot; name=&quot;Jane&quot;&gt;<br>
233
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group&gt;Friends&lt;/Group&gt;<br>
234 235 236 237 238 239 240 241 242
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;paul@xyz.net&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot; name=&quot;Paul&quot;&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&lt;/Roster&gt;<br>
&lt;/User&gt;<br>
</td>
</tr>
</table>
</div>
243 244 245
</p>

<p>
246
Mike and Jane's accounts both reside on server whose domain name is "im.olddomain.net" and are being 
247
imported to a Openfire installation whose server name is "im.newdomain.net". If on the import screen
248 249 250 251
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>
252
</p>
253

254
<p>
Matt Tucker's avatar
Matt Tucker committed
255
<div class="xmltable">
256 257 258 259 260 261 262 263 264 265 266 267
<table>
<tr>
<td>
&lt;User&gt;<br>
&nbsp;&nbsp;&lt;Username&gt;mike&lt;/Username&gt;<br>
&nbsp;&nbsp;&lt;Password&gt;iamcool&lt;/Password&gt;<br>
&nbsp;&nbsp;&lt;Email&gt;mike@mike.com&lt;/Email&gt;<br>
&nbsp;&nbsp;&lt;Name&gt;Mike Jones&lt;/Name&gt;<br>
&nbsp;&nbsp;&lt;CreationDate&gt;1125442154664&lt;/CreationDate&gt;<br>
&nbsp;&nbsp;&lt;ModifiedDate&gt;1125442154664&lt;/ModifiedDate&gt;<br>
&nbsp;&nbsp;&lt;Roster&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;jane@im.newdomain.net&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot; name=&quot;Jane&quot;&gt;<br>
268
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group&gt;Friends&lt;/Group&gt;<br>
269
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
270
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;paul@xyz.net&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot; name=&quot;Paul&quot;/&gt;<br>
271 272 273 274 275 276
&nbsp;&nbsp;&lt;/Roster&gt;<br>
&lt;/User&gt;<br>
</td>
</tr>
</table>
</div>
277
</p>
278

279
<p>
280
Below is a sample of an exported user list from Openfire than contains two users, Joe and Sally, who
281
have added each other to their respective rosters.
282
</p>
283

284
<p>
Matt Tucker's avatar
Matt Tucker committed
285
<div class="xmltable">
286 287 288 289 290
<table>
<tr>
<td>
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>
<br>
291
&lt;Openfire&gt;<br>
292 293 294 295 296 297 298 299 300
&nbsp;&nbsp;&lt;User&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Username&gt;joe&lt;/Username&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Password&gt;joepwd&lt;/Password&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Email&gt;&lt;/Email&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Name&gt;&lt;/Name&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;CreationDate&gt;1125601449177&lt;/CreationDate&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;ModifiedDate&gt;1125601449177&lt;/ModifiedDate&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Roster&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;sally@localhost&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot; name=&quot;Sally&quot;&gt;<br>
301
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group&gt;Friends&lt;/Group&gt;<br>
302 303 304 305 306 307 308 309 310 311 312
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Roster&gt;<br>
&nbsp;&nbsp;&lt;/User&gt;<br>
&nbsp;&nbsp;&lt;User&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Username&gt;sally&lt;/Username&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Password&gt;sallypwd&lt;/Password&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Email&gt;&lt;/Email&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Name&gt;&lt;/Name&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;CreationDate&gt;1125601471848&lt;/CreationDate&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;ModifiedDate&gt;1125601471848&lt;/ModifiedDate&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Roster&gt;<br>
313
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item jid=&quot;joe@localhost&quot; askstatus=&quot;-1&quot; recvstatus=&quot;-1&quot; substatus=&quot;3&quot;/&gt;<br>
314 315
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Roster&gt;<br>
&nbsp;&nbsp;&lt;/User&gt;<br>
316
&lt;/Openfire&gt;<br>
317 318 319 320
</td>
</tr>
</table>
</div>
321
</p>
322

323
<p>
324
Below is a list of the different status types and what their associated numbers mean.
325
</p>
326

Matt Tucker's avatar
Matt Tucker committed
327
<div class="datatable">
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
<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>
Matt Tucker's avatar
Matt Tucker committed
408

409
</div>
Matt Tucker's avatar
Matt Tucker committed
410 411
</div>

Ryan Graham's avatar
Ryan Graham committed
412
</body>
Matt Tucker's avatar
Matt Tucker committed
413
</html>