9,284
edits
Advanced sync setup: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
|||
| Line 1: | Line 1: | ||
{{Synchronization TOC}} | {{Synchronization TOC}} | ||
Sync Config, also called | '''Sync Config''', also called '''advanced sync setup''', is an XML configuration file that can be edited in Woodford. It allows you to modify the behavior of SyncDownloader, i.e., the part of synchronization responsible for the download of entity records, e.g. accounts, contacts, orders, ... Typically, this is the longest phase of [[synchronization]]. If you're familiar with the basic function of sync config, you can also '''[[Deep dive: Sync download optimization|dive into Sync download optimization]]'''. | ||
Additionally, Sync Config can be | Additionally, Sync Config can also be used to [[Advanced_sync_setup#Custom_upload_order|modify the '''upload order of entities''']]. | ||
== Editing the sync config file == | == Editing the sync config file == | ||
| Line 14: | Line 14: | ||
# Edit the XML configuration file, then click '''Save'''. | # Edit the XML configuration file, then click '''Save'''. | ||
We recommend | We recommend you prepare the file in an external editor and verify that it’s a valid XML file (for example, try opening the file in a web browser); then copy the content into Woodford. | ||
[[File:Advanced sync setup.png|600px]] | [[File:Advanced sync setup.png|600px]] | ||
Alternatively, for advanced testing and troubleshooting on the Windows platform, you can directly edit the file <code>MobileCrm\Configuration\SyncSetup.xml</code> in the project directory. Once you are happy with the results, copy your setup into Woodford as described above, to make it available | Alternatively, for advanced testing and troubleshooting on the Windows platform, you can directly edit the file <code>MobileCrm\Configuration\SyncSetup.xml</code> in the project directory. Once you are happy with the results, copy your setup into Woodford as described above, to make it available to all project users. | ||
== Why is this important? == | == Why is this important? == | ||
| Line 25: | Line 25: | ||
* To learn how, we start by explaining the internals of the synchronization process. | * To learn how, we start by explaining the internals of the synchronization process. | ||
* Then we introduce main variables that control sync performance. | * Then, we introduce the main variables that control sync performance. | ||
* Finally, we explain how to formally write the setup string. | * Finally, we explain how to formally write the setup string. | ||
== What is the SyncDownloader? == | == What is the SyncDownloader? == | ||
SyncDownloader executes perhaps the most important part of the synchronization - download of "normal" entity records. | SyncDownloader executes perhaps the most important part of the synchronization - the download of "normal" entity records. | ||
* It downloads accounts, contacts, orders, orderdetails... | * It downloads accounts, contacts, orders, orderdetails... | ||
* It does not download some special entities such as NN entities or activityparty's. | * It does not download some special entities such as NN entities or activityparty's. | ||
* It does not download attachments, images. | * It does not download attachments, images. | ||
* It does not execute upload of client changes to the server. | * It does not execute upload of client changes to the server. | ||
* It does not perform sync with SharePoint, OneDrive, Google Drive etc. | * It does not perform sync with SharePoint, OneDrive, Google Drive, etc. | ||
For a typical configuration, most of the sync time is spent in the SyncDownloader. | For a typical configuration, most of the sync time is spent in the SyncDownloader. | ||
| Line 41: | Line 41: | ||
== Measuring performance == | == Measuring performance == | ||
The following describes in deeper detail how the SyncDownloader works. If you understand this, you | The following describes in deeper detail how the SyncDownloader works. If you understand this, you can fine-tune the SyncDownloader to maximize its performance. | ||
Let's start with a simple question: How can we measure the sync performance? | Let's start with a simple question: How can we measure the sync performance? | ||