Overview

The user import/export plugin provides a way to import and export Openfire user data via 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 of users from other Jabber/XMPP based systems to Openfire.

Installation

Copy the userImportExport.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new userImportExport.jar file over the existing file.

Configuration

Presently, there is nothing that can be configured for the user import/export plugin.

Using the Plugin

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 a read-only user store such as LDAP or POP3 this plugin will still work with two caveats:

  1. When exporting, the username will be placed in the password element.
  2. When importing, no new users will be created but if the user exists in the user store thier roster will be loaded.
  • Importing - 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, except in the case of using a read-only user store.

  • Exporting - 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.

  • Migration - To import user data from another instant messaging system using the plugin, the import file must conform to the openfire-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 Openfire installation. For example, say you have a user whose roster looks like:

    • <User>
      <Username>mike</Username>
      <Password>iamcool</Password>
      <Email>mike@mike.com</Email>
      <Name>Mike Jones</Name>
      <CreationDate>1125442154664</CreationDate>
      <ModifiedDate>1125442154664</ModifiedDate>
      <Roster>
        <Item jid="jane@im.olddomain.net" askstatus="-1" recvstatus="-1" substatus="3" name="Jane">
          <Group>Friends</Group>
        </Item>
        <Item jid="paul@xyz.net" askstatus="-1" recvstatus="-1" substatus="3" name="Paul">
        </Item>
      </Roster>
    </User>

    Mike and Jane's accounts both reside on server whose domain name is "im.olddomain.net" and are being imported to a Openfire 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:

    <User>
      <Username>mike</Username>
      <Password>iamcool</Password>
      <Email>mike@mike.com</Email>
      <Name>Mike Jones</Name>
      <CreationDate>1125442154664</CreationDate>
      <ModifiedDate>1125442154664</ModifiedDate>
      <Roster>
        <Item jid="jane@im.newdomain.net" askstatus="-1" recvstatus="-1" substatus="3" name="Jane">
          <Group>Friends</Group>
        </Item>
        <Item jid="paul@xyz.net" askstatus="-1" recvstatus="-1" substatus="3" name="Paul"/>
      </Roster>
    </User>

    Below is a sample of an exported user list from Openfire than contains two users, Joe and Sally, who have added each other to their respective rosters.

    <?xml version="1.0" encoding="UTF-8"?>

    <Openfire>
      <User>
        <Username>joe</Username>
        <Password>joepwd</Password>
        <Email></Email>
        <Name></Name>
        <CreationDate>1125601449177</CreationDate>
        <ModifiedDate>1125601449177</ModifiedDate>
        <Roster>
          <Item jid="sally@localhost" askstatus="-1" recvstatus="-1" substatus="3" name="Sally">
            <Group>Friends</Group>
          </Item>
        </Roster>
      </User>
      <User>
        <Username>sally</Username>
        <Password>sallypwd</Password>
        <Email></Email>
        <Name></Name>
        <CreationDate>1125601471848</CreationDate>
        <ModifiedDate>1125601471848</ModifiedDate>
        <Roster>
          <Item jid="joe@localhost" askstatus="-1" recvstatus="-1" substatus="3"/>
        </Roster>
      </User>
    </Openfire>

    Below is a list of the different status types and what their associated numbers mean.

    askstatus
    -1 The roster item has no pending subscripton requests.
    0 The roster item has been asked for permission to subscribe to their presence but no response has been received.
    1 The roster owner has asked to the roster item to unsubscribe from it's presence but has not received confirmation.

    recvstatus
    -1 There are no subscriptions that have been received but not presented to the user.
    1 The server has received a subscribe request, but has not forwarded it to the user.
    2 The server has received an unsubscribe request, but has not forwarded it to the user.

    substatus
    -1 Indicates the roster item should be removed.
    0 No subscription is established.
    1 The roster owner has a subscription to the roster item's presence.
    2 The roster item has a subscription to the roster owner's presence.
    3 The roster item and owner have a mutual subscription.