Introduction to MagicSync Pro
Introduction

MagicSync was created to allow custom content of any type to be synchronized with any Pocket PC over the Internet.

The content provider creates a fully automated installer file, created by the MagicSync Client Creator, that (s)he provides to his clients. This Client Creator allows you to specify a logo image and company information to be displayed while the user synchronizes.

This automated installer file, created by the Client Creator, installs the MagicSync Client and data file on the user’s desktop computer.

The MagicSync data file specifies the location of a file list on a public or private (using a login and password scheme) web server. MagicSync gets its file list from the server to allow content providers to dynamically update their files, remove old unused files or add new files without requiring the user to change their configuration.

It’s also possible to add links to the favorites folder of Pocket Internet Explorer (for offline browsing) and to the Start Menu for direct launch of all registered extensions recognised by your Pocket PC.

Every time the user docks its device in the cradle, MagicSync will automatically be launched to start updating all the specified files and folders.


MagicSync Pro Installation
Installation

Just run setup.exe and follow the instructions on screen.

MagicSync Pro will install a shortcut on the desktop and in the start menu. When you use this shortcut, to start the Client, the Auto Close feature of MagicSync Pro will be disabled, so you can use this to change your settings in MagicSync. If MagicSync starts automatically during syncing, it will also close automatically (standard setting) when it has finished—this way you won’t be able to reach the settings.

On the Pocket PC you need to create a new directory where you want to store all the data retrieved by MagicSync. This directory can be on a storage card. Should the storage card not be present whilst synchronising, MagicSync will prompt you for an alternative location. To create a new directory on the device, use file explorer, click the right mouse button and select New Folder.


MagicSync Pro proxy settings
Proxy Settings

You can change the proxy settings in Options->Proxy settings. There you will have the choice between three options:

•	Direct connection: This lets you connect to the Internet without using a proxy server. Choose this option when you are sure you are not behind a corporate firewall or your ISP doesn’t require you to use a proxy.

•	IE Proxy settings: MagicSync uses the proxy settings from your web browser. If you have no idea what option to choose and you can connect to the Internet using your web browser, select this option.

•	Manual settings: This allows you to explicitly specify the proxy server and optionally the user name and password, if required. You get the proxy settings from your system administrator or your ISP. Typically they will provide you with a server name and a port number that you need to type over in the following format: <proxy server>:<port number>.

For example, if your proxy server is called proxy.myisp.com and the port number is 8080, you will have to type proxy.myisp.com:8080.

If you are supplied with a user name and password, you can write those in the appropriate edit box when you check the Proxy Authorisation Required.


MagicSync Pro device path
Device Path

In options you can set the device path. This is the root folder where all downloaded content will be put. Each content provider will specify a separate sub-folder where its file(s) will be put. So if you specify as root folder: \storage card\MyFolder and your provider specified as folder Chemicals, the final folder where the content will be placed will be:

\storage card\MyFolder\Chemicals

You can check the ‘don’t ask again’ box if you want to use that folder each time you synchronize, which is probably what you want.


MagicSync Pro auto close feature
Auto Close

When you enable this option, MagicSync will automatically close when it has finished synchronising. The Auto Close feature, however, will be disabled in the following cases:

•	MagicSync has been started manually using the link on the desktop or in the Start menu. This has been done to allow the user to change the settings.

•	There were errors during synchronisation.

Advanced: Auto Close can be disabled using the command line option /manual.


MagicSync Pro general information
General

MagicSync checks for installed MagicSync Data Files on the desktop computer and then executes them one by one. The Data File contains the information MagicSync needs to synchronize. Each Data File can be uninstalled separately using the normal Windows uninstallation procedure:

Start -> Control Panel -> Add/Remove software.


MagicSync main window
Main Window

The details button toggles the display of the details window.

If MagicSync isn’t synchronising you’ll see the following buttons:

•	Close: This closes the MagicSync application.

•	Synchronize: Press this button to start synchronisation.

When MagicSync is busy synchronising:

•	Cancel this job: Press this button if you want to stop the synchronisation of the current link.

•	Cancel all jobs: Press this button to completely stop synchronising.

Force update to device: Check this if you want MagicSync to download and refresh all data whether or not it’s already present on the device.


MagicSync details window
The Details Window

In this window you can view each connection MagicSync is making to update the files to your device. Each connection can be in four different states.

•	OK : The file is up to date on the Pocket PC.

•	Error : There was an error during synchronisation. See the status description for a detailed explanation of the error.

•	Connecting : MagicSync is attempting to open a connection to the server that contains the data.

•	Queued: This file has been placed in the connection queue and will be synchronised shortly.


MagicSync Pro uninstallation
Uninstallation

Each data file in MagicSync Pro is installed separately and can be uninstalled using the normal procedure:

Start -> Settings -> Control Panel -> Add/Remove software

Select the company name of the service you want to uninstall.

MagicSync Pro can also be removed from your system using the procedure described above. When removing MagicSync Pro, first uninstall all data files.


Client Creator general information
General

The MagicSync Client Creator is used to customise the display of MagicSync during synchronisation to your site. When you finish the Client Creator wizard you will end up with an executable and an .mdf-file. The executable contains the complete install files for MagicSync Pro and the .mdf-file, so all you need to do is distribute the executable to your clients.

You can use the .mdf-file with MagicSync Pro to test your configuration locally.


Client Creator new project page
Create new project or modify existing project

The project file contains all the information needed to create the data file and the installer file that you can distribute among your clients. The project file is used to quickly correct errors made during the creation of the data file.

Create New Project

Fill in the name of your project and use the ‘Choose Destination’ button to place the project file in the folder of your choice. Nothing more is required.

Modify existing project

Use the ‘Select Project File’ button to browse to the location of your previously saved project file.

Advanced: The project file contains human readable text and several fields. If multiple fields with the same identifier are found only the first one will be used and the rest is discarded.


Client Creator url page
URL Page

In this page you type the URL to the server configuration file. This link should point to the file itself and not the directory containing the file.

You can also specify whether the server needs authentication in order to access the files. To do this check the ‘Authorisation Required’ box and fill in the user name and password.

Check with your system administrator to see if your web server requires a user name and password. This feature has been included in MagicSync to provide a general way to access web servers, this is not the same as encryption.

Should you for any reason need to transfer data encrypted, contact magicsync@aimproductions.be for more information.


Client Creator image page
Image Page

Click the ‘Browse for Client Image’ button to select the picture you want to be displayed when MagicSync is synchronising your content. The dimensions of the picture should be 150*110 pixels and the file format should be Windows Bitmap (.bmp).

The picture should ideally be your company logo, but it can be anything you choose. The URL you fill in below the picture is the link the user of MagicSync Pro will be taken to when (s)he clicks the image in MagicSync.

If you don’t supply a picture and link, the picture will default to the logo of AIM Productions and link to the MagicSync website.


Client Creator information page
Information Page

Here you can fill in the information you want to be displayed to the right of your picture while MagicSync Pro is synchronising with your site.

•	Company/service: Here you write your company name or the name of the service you are providing.

•	Support e-mail: The e-mail address your users can contact you in case they have problems connecting to your site.

•	Splash text: You can use this field to display extra information. This text can also be overridden in the Server Configuration File.

The company/service field obligatory since this is the name the installer uses this to register your application with the Windows OS.

Advanced: the system used to register your custom Data File is based on Installshield. The installer creates a <companyname>.isu file (installation log file) in the directory where MagicSync is installed. <companyname> will be replaced with the text you fill in Company/service. This system was used so the users can install and uninstall each Data File separately.


Client Creator save page
Save Page & Finish page

Save Page

In save page you can choose the name and destination of the MagicSync Installer and data file. Click the buttons to do this.

TIP: As destination for the data file, choose the directory where MagicSync Pro is located. When you finish the Client Creator all you need to do is start up MagicSync Pro and it will detect the new data file. This is a quick way of verifying the data you entered in the Client Creator.

Finish Page

In the finish page you will be presented with three buttons that open the folder(s) of the Project file, the Installer File and the Data file.


Client Creator testing your data files
Testing

When you finish the Client Creator three files are made:

•	MagicSync Project File: saves all the information you entered in the wizard.

•	MagicSync Data File: used by MagicSync Pro to connect to your server.

•	MagicSync Installer: The MagicSync Installer produced by the Client Creator contains the complete installation of MagicSync Pro and your custom data file.

You can test the configuration of your custom file in two distinct ways:

•	Manually copy your .mdf file to the MagicSync program directory. Usually located in Program files\AIM Productions\MagicSync.

•	In the Client Creator choose the MagicSync program directory as destination of the data file.

Then you start up MagicSync Pro and check for errors.


Client Creator: Distributing the installer file
Distribution

You successfully created a new client. All you need to do now is to distribute the magic.exe file to your new) customers. The file contains the complete installation of MagicSync Pro and your data file. When magic.exe is run, the installation will check if MagicSync Pro is already installed, and if necessary it will automatically start installing the Pro version after which it will proceed to install your data file.

This data file is placed in the list of packages to update and remains there until the user uninstalls your data file. Removal can be done using the normal Windows uninstallation procedure.

Start -> Settings -> Control Panel -> Add/remove Programs


Server Configuration File general information
General

The Server Configuration File primarily contains the file list that needs to be synchronised with the Pocket PC. This file is an ordinary text file that can be easily edited by notepad (Windows) or vi (Unix). The filename and extension of the Configuration File is only restricted by the limits opposed on it by the Operating System, which means for most practical uses it can be anything you want.

We use the following syntax:

[optional]	Everything put between square brackets is an optional parameter.

<filename>	Replace this with the item described in the angular brackets.

Advanced: The syntax of this file has been designed to allow scripting languages to easily modify or generate the contents of this file.


Inserting comments
Comments

Syntax: # (at the start of a line)

Example:

#this is an example of a comment

Each line in the configuration file that starts with # is ignored by MagicSync. This can be used to insert comments, temporarily disable certain items in the file or use it as tag points for script languages.


Header directive
Header

Syntax: Header: <Identification string>

Example:

Header: MagicSync V1.0

The header syntax is for MagicSync to verify the version of the configuration file. It should always be:

Header: MagicSync V1.0

If multiple ‘header:’ strings are found only the first one is used and the others are ignored.


Cefolder directive
CeFolder

Syntax: Cefolder:<foldername>

Example:

Cefolder: AIM Productions

This allows you to specify the folder name where your content will be placed on the user’s device. This folder name is relative to the folder the user specified. So for example, if the user specified: \storage card\MagicSync as root folder and you specified:

CeFolder: MyCompany

...then the final path would be \storage card\MagicSync\MyCompany.


File directive
File

Syntax: File:<filename>[,link:<IE Link name>][,exe:<Start Menu Name>]

Example:

File:Reviews\QubixLores.avi,link:Low res video review of Qubix,exe:Qubix review

Here you list the file MagicSync needs to update. The path you enter here is relative to the path of the Server Configuration File. MagicSync Pro recreates the same folder structure on the user’s device. You specify File: for each file that needs to be updated.

You can use the Link: option to add a link from the user’s Pocket Internet Explorer to this file. The link will be saved in the Favorites folder with the same name as Cefolder.

The Exe: option works the same way as the Link: option, but it adds the file to the Pocket PC’s Start Menu instead of the Favorites folder.

The links (Start menu and Pocket IE) are processed using a shell execute command. This means that if the file extension is recognised by Windows CE, the appropriate programs are started. .AVI is for example recognised by Windows CE and Media Player is its associated program. So if add a link using Link: or Exe: to an .avi file, Media Player is automatically started when the users open the link.


URL directive
URL

Syntax: Url:<url link>[,link:<IE Link name>][,exe:<Start Menu Name]

Example:

Url:http://www.aimproductions.be/reviews/qubix.avi

This works in the same way as the File: does, but allows you to specify a URL link to any site on the net. The file that the URL points to, will be downloaded to the device.


Splash directive
Splash

Syntax: Splash:<text>

Example:

Splash:The new video review of qubix is out!

Splash allows you to specify an alternate splash text to be displayed while synchronising. If multiple splash: strings are specified, only the first one is displayed.


Server Configuration File example
Server Configuration File Sample

#First place the header so MagicSync Pro can validate this file

Header:Magicsync v1.0

#Now specify the folder name on the user’s Pocket PC

Cefolder:AIM_NewsLetter

#Override the splash text in the Data File

splash:The August NewsLetter

#Add the web page and link

file:newsletter2.html,Link:AIM Productions Latest News

#and include some additional graphics that were used on the web page

file:help_gfx/dollar2.jpg

file:help_gfx/floppy.jpg

file:help_gfx/logo.jpg

file:help_gfx/logo2.jpg

file:help_gfx/pp.gif

file:help_gfx/pp2.gif

file:help_gfx/pppc.gif

file:help_gfx/uitroep.jpg


Differences between lite and pro version
Limitations of the lite version

•	You can only transfer up to 10 files.

•	All files are saved in My Documents\MagicSync folder instead of a folder of the user’s choice. No sub-folders are created.

•	No creation of links in the start menu or in pocket internet explorer

•	No automatic start up and close when cradling the device.

•	The display can’t be customised: Logo Image, homepage link in logo, splash text, etc…

•	Only available for personal use, for commercial use you must license the Pro version.