readme.html 11 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 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
<title>User Import/Export Plugin Readme</title>
<style type="text/css">
   BODY {
      font-size : 100%;
   }
  
   BODY, TD, TH {
      font-family : tahoma, verdana, arial, helvetica, sans-serif;
      font-size : 0.8em;
   }
  
   H2 {
      font-size : 11pt;
      font-weight : bold;
   }
  
   A:hover {
      text-decoration : none;
   }
  
   H1 {
      font-family : tahoma, arial, helvetica, sans-serif;
      font-size : 1.4em;
      font-weight: bold;
      border-bottom : 1px #ccc solid;
      padding-bottom : 2px;
   }

   TT {
      font-family : courier new;
      font-weight : bold;
      color : #060;
   }
  
   PRE {
      font-family : courier new;
      font-size : 100%;
   }
  
   #datatable TH {
      color : #fff;
      background-color : #2A448C;
      text-align : left;
   }
  
   #datatable TD {
      background-color : #FAF6EF;
   }
  
   #datatable .name {
      background-color : #DCE2F5;
      text-align : center;
   }
58 59 60 61
   
   #xmltable TD {
      background-color : #C3FDB8;
   }
62
</style>
Ryan Graham's avatar
Ryan Graham committed
63 64 65 66 67 68
</head>
<body>

<h1>User Import/Export Plugin Readme</h1>

<h2>Overview</h2>
69
<p>The user import/export plugin provides a way to import and export Wildfire user data via
70 71
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 
72
Jabber/XMPP based systems to Wildfire.</p>
Ryan Graham's avatar
Ryan Graham committed
73 74

<h2>Installation</h2>
75
<p>Copy the userImportExport.jar into the plugins directory of your Wildfire installation.
76 77
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
78 79 80 81 82

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

<h2>Using the Plugin</h2>
83 84 85
<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 
86
will not work with your Wildfire installation."
87 88 89 90 91 92 93
<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 
Ryan Graham's avatar
Ryan Graham committed
94
information.</li>
95 96 97 98 99 100 101
<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 
102
the provided text area.</li>
103
<br>
104 105
<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
106 107 108
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 
109
entries domain names to server name of your Wildfire installation. For example, say you have a user
110 111
whose roster looks like:
</li>
112
<br>
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

<div id="xmltable">
<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>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group&gt;&lt;/Group&gt;<br>
&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;&nbsp;&nbsp;&lt;Group&gt;&lt;/Group&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&lt;/Roster&gt;<br>
&lt;/User&gt;<br>
</td>
</tr>
</table>
</div>
138 139
<br>
Mike and Jane's accounts both reside on server whose domain name is "im.olddomain.net" and are being 
140
imported to a Wildfire installation whose server name is "im.newdomain.net". If on the import screen
141 142 143 144 145
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>
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

<div id="xmltable">
<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>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group&gt;&lt;/Group&gt;<br>
&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;&nbsp;&nbsp;&lt;Group&gt;&lt;/Group&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&lt;/Roster&gt;<br>
&lt;/User&gt;<br>
</td>
</tr>
</table>
</div>
171 172 173

<br>
<br>
174
Below is a sample of an exported user list from Wildfire than contains two users, Joe and Sally, who
175 176 177 178
have added each other to their respective rosters.
<br>
<br>

179 180 181 182 183 184
<div id="xmltable">
<table>
<tr>
<td>
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>
<br>
185
&lt;Wildfire&gt;<br>
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
&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>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group/&gt;<br>
&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>
&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>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Group/&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Item&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Roster&gt;<br>
&nbsp;&nbsp;&lt;/User&gt;<br>
212
&lt;/Wildfire&gt;<br>
213 214 215 216
</td>
</tr>
</table>
</div>
217 218 219 220 221 222

<br>
<br>
Below is a list of the different status types and what their associated numbers mean.
<br>
<br>
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
<div id="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>
Ryan Graham's avatar
Ryan Graham committed
305 306
</body>
</html>