Upvise SyncTool

1. Overview
2. Supported Upvise Applications
3. Requirements
4. Authentication
5. How to use
6. Data Export
7. Data Import
8. XML Field Names Reference

Overview

Upvise SyncTool is a Windows client application tool which simplifies import / export of Upvise account data and allows synchronization of these data with external databases. The Upvise SyncTool implements the Upvise MAX protocol to communicate with Upvise servers and thus provides an optimized and secure data transfer between a client machine/server where the tool resides.

Supported Upvise Applications

The following data tables are supported with this version of the Upvise SyncTool:

• Upvise Contacts (Contacts, Companies, Groups, Regions tables),
• Upvise Notebooks (Notes and Notebooks tables)
• Upvise Tasks (Tasks and Tasklists tables)

Requirements

Microsoft Windows .NET 2.0 is required for the Upvise SyncTool, along with Windows 2003 Server, 2008 Server, XP SP2, Vista or Windows 7.

Authentication

The Upvise SyncTool requires the email / password of an Upvise account, with Admin privileges.

How to use the Upvise SyncTool

Start the upvisesync.exe tool,

• Enter your email / password
• Press Download to download the data. Data is stored in XML format under the "out" folder below the executable path.
• To upload data, generate an XML file with the data you want to upload and press the Upload Button. If you data was correctly uploaded the file is deleted by the tool

Data Export

The Upvise SyncTool exports the Contacts, Tasks, Notes application data tables as local XML files. Each data table is stored in one XML file, in the "out" folder unde under the tool executable location

The XMLformat used is very simple.

• Each file has a root node named channel. this node has 2 attributes, title which contains the name of the data table and lastBuildDate which contains the date of the last request to the server. This date is expressed in UNIX Epoch Time (milliseconds since Jan 1st 1970 GST).
• The root node contains 0 or more <item> children nodes, one for each record.
• Each item has a list of children field nodes. All <item> nodes share the same structure.
• The name of each field node depends on the data table. See the next section for the list of field node names for each table
• Field nodes with an empty value are omitted. For example is a company has an empty website field value, the <website> node does not appear in the XML for this record
• 2 field nodes are common to all tables, the <id> field node, which contains a unique ID amongst the data table is the record primary key
• and the <_date> node is a timestamp which indicates the last modified date for the record.
• Deleted items appear only with the <id> child field node and a _deleted="1" attribute.
  

 <channel lastBuildDate="someDate" title="unybiz.contacts.contacts">
    <item>
        <_date>LastModifiedDate<_date>
        <id>ID1<id>
        <fieldname1>value2</fieldname1>
        <fieldname1>value2</fieldname1>
        ....... More fields here specific to each data table structure

        </item>
    <!-- .... More item nodes below, all sharing the same set of field nodes -->
  
   <item _deleted="1">  <!-- This is the case of a deleted item, -->
        <id>ID3<id>
  </item>
</channel>

Data Import

To, import new records, updated records or deleted records into the Upvise Database, you have to generate an XML file named as the table and put it under the "out" folder below the application executable path.
This XML file has the exact same structure a the one described below, with one exemption : the _date field (which is ignored).

For example, to import a new company record into an Upvise account, generate the following XML file named "unybiz.contacts.companies" and store in in the "out" folder.
The id field node is optional : if it is not present, Upvise will generate a unique random ID of your new record. If you specify an ID, make sure it is unique.

<channel title="unybiz.contacts.companies">
    <item>
        <id>446775344</id>
	<name>Google</name>
	<website>http://www.google.com</website>
	<street>1 Google Way</street>
	<zipcode></zipcode>
	<city>Mountain View</city>
	<country>USA</country>
	<mapurl>37.42423,-122.085228</mapurl>
     <item>
</channel>

XML Field Names Reference

unybiz.contacts.companies : Companies Table

unybiz.contacts.groups : Groups Table

unybiz.contacts.regions : Regions Table

uny.notes.notes  : Notes Table

uny.notes.notebooks

unbiz.tasks.tasks : Tasks Table

unybiz.tasks.lists : Tasklists Table