Discussion:
[Funambol-developers] iSync plugin Design Document
Valentino Massaro
2007-07-30 10:38:33 UTC
Permalink
Hi all,
this is a first draft of iSync to Funambol plugin design document.
Now I'll start to write the code.

Let me know your comments.

Regards,

Valentino
Stefano Fornari
2007-07-30 14:38:02 UTC
Permalink
Ciao Valentino,
it looks a pretty good document to me. I do not have major concerns,
just some random comments.

1. editorial: please make sure you do not have empty lines between
text objects or images. Use styles and frame margins instead.
2. editorial: there is some Outlook plug-in quoted somewhere.
3. "4.2 AddressBookSyncSource": the description is either too detailed
or too vague. I mean that it is maybe a bit too detailed for an high
level design, but too vague for a detailed design. I would suggest to
stay high level, and explain how the SyncSource interact with the
client on one side and how it interacts with the mac sync engine on
the other side. Do not explicit that you create a pointer or so. One
or more sequence diagrams are probably appropriate (again, you do not
have to go at the code level... there is the code for that :) ).
4. still in the same section, why do we need to keep the lists of ids
(I think I understand why, but it is not clear in the design); I guess
it is missing a brief overview of how a mac sync application should
work.
5. in 4.3 there is a missing reference
6. in 4.4. "Here is a list with descriptions of main DLL interface
functions used by UI": what does this actually mean? I guess here a
description about how TargetApplication can use such methods is
missing.
7. check that what specfied in the table make sense for the reader;
for example, what's ABAddressBook? what's the sync mutex? Everything
quoted there must refer to information already obtained reading the
previous sections.
8. I would add a specific section about how to terminate the sync;
this is usually an aspect easy to neglect, but it is instead crucial
to give a proper user experience. An application lifecycle section
could probably make it.
9. As above, error and exceptions is another section that is very
important. Please spend more words on it (we do not have to fill it
completely now, you can update it over time while developing).
10. editorial: please create a reference for each reference and use
the OO reference fields.

I think this is all for now.

I look forward to reading the next draft.

Ste
Post by Valentino Massaro
Hi all,
this is a first draft of iSync to Funambol plugin design document.
Now I'll start to write the code.
Let me know your comments.
Regards,
Valentino
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
--
Stefano Fornari - Funambol Chief Architect / Funambol CTO
=======================================================
Home:
http://www.funambol.org

Documents:
http://www.funambol.org/documentation/documents.html

FAQ:
http://www.funambol.org/support/faq.html

WIKI:
https://wiki.objectweb.org/sync4j/

Mailinglist archives:
http://groups.yahoo.com/group/Sync4j (login required)
http://sourceforge.net/mailarchive/forum.php?forum_id=215 (sync4j-users)
http://sourceforge.net/mailarchive/forum.php?forum_id=48877
(funambol-dev)

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
Valentino Massaro
2007-07-30 16:35:57 UTC
Permalink
Hi Stefano,
thank you for your comments,
I'll fix soon what you've noticed and will repost the document.

Valentino
Post by Stefano Fornari
Ciao Valentino,
it looks a pretty good document to me. I do not have major concerns,
just some random comments.
1. editorial: please make sure you do not have empty lines between
text objects or images. Use styles and frame margins instead.
2. editorial: there is some Outlook plug-in quoted somewhere.
3. "4.2 AddressBookSyncSource": the description is either too detailed
or too vague. I mean that it is maybe a bit too detailed for an high
level design, but too vague for a detailed design. I would suggest to
stay high level, and explain how the SyncSource interact with the
client on one side and how it interacts with the mac sync engine on
the other side. Do not explicit that you create a pointer or so. One
or more sequence diagrams are probably appropriate (again, you do not
have to go at the code level... there is the code for that :) ).
4. still in the same section, why do we need to keep the lists of ids
(I think I understand why, but it is not clear in the design); I guess
it is missing a brief overview of how a mac sync application should
work.
5. in 4.3 there is a missing reference
6. in 4.4. "Here is a list with descriptions of main DLL interface
functions used by UI": what does this actually mean? I guess here a
description about how TargetApplication can use such methods is
missing.
7. check that what specfied in the table make sense for the reader;
for example, what's ABAddressBook? what's the sync mutex? Everything
quoted there must refer to information already obtained reading the
previous sections.
8. I would add a specific section about how to terminate the sync;
this is usually an aspect easy to neglect, but it is instead crucial
to give a proper user experience. An application lifecycle section
could probably make it.
9. As above, error and exceptions is another section that is very
important. Please spend more words on it (we do not have to fill it
completely now, you can update it over time while developing).
10. editorial: please create a reference for each reference and use
the OO reference fields.
I think this is all for now.
I look forward to reading the next draft.
Ste
Post by Valentino Massaro
Hi all,
this is a first draft of iSync to Funambol plugin design document.
Now I'll start to write the code.
Let me know your comments.
Regards,
Valentino
---------------------------------------------------------------------
----
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
--
Stefano Fornari - Funambol Chief Architect / Funambol CTO
=======================================================
http://www.funambol.org
http://www.funambol.org/documentation/documents.html
http://www.funambol.org/support/faq.html
https://wiki.objectweb.org/sync4j/
http://groups.yahoo.com/group/Sync4j (login required)
http://sourceforge.net/mailarchive/forum.php?forum_id=215 (sync4j-
users)
http://sourceforge.net/mailarchive/forum.php?forum_id=48877
(funambol-dev)
----------------------------------------------------------------------
---
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a
browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
Harrie Hazewinkel
2007-07-30 15:07:45 UTC
Permalink
HI,


A couple of questions.


1) Do you make an iSync plugin or a preferences Plugin?
Looking at the pdf file, I have the idea the latter.

2) If you are making an iSync plugin, I guess you need to
describe a bit the use-cases, since you basically will
have a 'new' device in the iSync application like the
.Mac service.

3) Since it seems that iSync first collects changes for
the local application and the device (this case the
remote server) I guess you want to download the
many documents from the apple developers website and
include the iSync API usage in the document.



Harrie
Post by Valentino Massaro
Hi all,
this is a first draft of iSync to Funambol plugin design document.
Now I'll start to write the code.
Let me know your comments.
Regards,
Valentino
<iSynctoFunambol_DesignDocument_0.9.odt>
<iSynctoFunambol_DesignDocument_0.9.pdf>
----------------------------------------------------------------------
---
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a
browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
Harrie
------------------------------------------------------------------
Funambol - Professional Services, Netherlands
http://www.funambol.com/



-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
Valentino Massaro
2007-07-30 16:42:06 UTC
Permalink
Post by Harrie Hazewinkel
HI,
A couple of questions.
1) Do you make an iSync plugin or a preferences Plugin?
Looking at the pdf file, I have the idea the latter.
It is a System Preferences plugin, is called "iSync" because it syncs
the two main
iSync-synchronized applications (Address Book and iCal)
Post by Harrie Hazewinkel
2) If you are making an iSync plugin, I guess you need to
describe a bit the use-cases, since you basically will
have a 'new' device in the iSync application like the
.Mac service.
See above
Post by Harrie Hazewinkel
3) Since it seems that iSync first collects changes for
the local application and the device (this case the
remote server) I guess you want to download the
many documents from the apple developers website and
include the iSync API usage in the document.
See above too :)
Post by Harrie Hazewinkel
Harrie
Post by Valentino Massaro
Hi all,
this is a first draft of iSync to Funambol plugin design document.
Now I'll start to write the code.
Let me know your comments.
Regards,
Valentino
<iSynctoFunambol_DesignDocument_0.9.odt>
<iSynctoFunambol_DesignDocument_0.9.pdf>
---------------------------------------------------------------------
-
---
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
Harrie
------------------------------------------------------------------
Funambol - Professional Services, Netherlands
http://www.funambol.com/
----------------------------------------------------------------------
---
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a
browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Funambol-developers mailing list
https://lists.sourceforge.net/lists/listinfo/funambol-developers
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/

Loading...