Synchronization in Apogée

Getting the sources

The Apogée synchronization module has been split into several plugins. You can download their sources from the Nuxeo SVN repository at:

http://svn.nuxeo.org/pub/browser/Apogee/trunk/sync

In this directory, you will find the following Eclipse plugin projects:

• org.nuxeo.apogee.sync
• org.nuxeo.apogee.sync.jcr
• org.nuxeo.apogee.sync.jackrabbit

For the synchronization to work, you will need these three plugins and their dependencies that you can find in the SVN platform directory.

Running Apogée

Apogée is not packaged yet. Thus you will have to run Apogée as a set of plugins in an Eclipse instance. Follow these steps to get it running.

First, import all the projects contained in the platform directory and the three ones listed above in the sync directory. Now select the Run > Run... menu entry and add a new Eclipse Application. In the plugins tab, select the "Choose plugins and fragments option" and select all the workspace plugins. To simply add all their dependencies, click on the "Add required Plug-ins" button: your Eclipse Application will just run the Apogée plugins.

Now return in the "Main" tab, choose "Run an application" and make sure that org.eclipse.ui.ide.workbench is selected. Now apply and run the newly created Eclipse Application.

Configuring Apogée synchronisation

To get the Apogée views, switch the perspective to the Apogée one. Then you should see the Apogée navigator on the left. A synchronization console is also available if you open the Console view.

First of all, you will need to configure your access to funambol using the Apogée preferences. Choose the Funambol Connection preference page to configure your access. This paper will assume that you have already added a username device id and principal to the funambol installation. Thus enter them on this page, for example:

• username : me
• password : mysecret
• device id : Apogee

You shouldn't have to change the other values if you are using the Funambol bundle. Now you will be able to connect to Funambol and synchronize. However you will have to tell Apogée what to synchronize.

Configuring a synchronization source

Let us assume that you already have created a JCR repository for Apogée. This one is named foo and has a default workspace. Right-click on the default node and choose the Properties menu item. There you will fill all the data concerning the server side source to synchronize with. This tutorial, assumes that a JCR source has been configured on the Funambol server side using the following parameters:

• name : jackrabbit_foo
• uri : jackrabbit_foo_uri

Then fill in the corresponding field of the properties pages with these values. If you are using a default Jackrabbit repository on the server side, the username can be "username" and the password can be "password". However, you will have to adapt this to your JCR repository configuration.

The JCR access and JCR location fields are concerning the local data to synchronize. You should not change them and may be these will be hidden later.

Then validate the properties, and your source is configured. To unactivate the synchronization for this workspace, simply open its properties and uncheck the "Synchronize" box.

Run the synchronization

To run, the synchronization of all the configured sources, just click on the top-right icon of the Apogée navigator. The log messages should appear in the console view.