5,925
edits
Changes
Jump to navigation
Jump to search
Created page with "Synchronization filters define what data from the server is replicated in the Resco Mobile CRM application after a synchronization. Filters are defined in Woodford..."
Synchronization filters define what data from the server is replicated in the [[Resco Mobile CRM]] application after a [[synchronization]]. Filters are defined in [[Woodford]]; each entity for each app project can have custom settings.
== Introduction ==
There are two types of synchronization: initial (full) synchronization, and incremental synchronization.
* Full synchronization is performed for example when the mobile app is used for the first time. In these cases, apps download data from the CRM server depending on the sync filter, so the sync filter is used to define what data is being downloaded to the Mobile CRM app's local database.
* In case of an incremental synchronization, the app downloads all records (that the user has permission for) that were created or updated since the last synchronization. Subsequently, the sync filters are used to only keep the records that follow the sync filters in the local database.
When setting up a Sync Filter, a condition can be defined for the CRM database entities (rows) which will be synced to your mobile device. Please keep in mind the capacity of mobile devices.
== Example ==
In this example, we set up a Sync Filter for opportunities that were created within the last 120 days.
# Edit an app project in Woodford.
# Select the entity '''Opportunity''' from the '''Project''' menu.
# Click '''Sync Filter'''.
# Define the filter:
#* Click '''Add condition'''. A default condition is created for '''Actual Close Date''', which is the first field of the entity, with the default operator '''Contains Data'''.
#* Click the field and select '''Created On''' from the dropdown menu.
#* Click the operator and select '''Last X Days''' from the dropdown menu.
#* Enter the number: 120.
# Click '''Save & Close'''.
== Incremental linked sync filters ==
Incremental linked sync filter, available for Dynamics CRM, ensures that linked filters on entities are checked during incremental synchronization. Without enabling it, the only initial filter for downloading records from server is the one checking whether the entity records were changed since last synchronization.
The use case for this filter is best shown on an example:
* The owner of an existing account is changed to the current user of the application, while the sync filters are set to only allow user-owned account to be stored in the offline database.
* As a result, the changed account record is downloaded (based on the incremental synchronization definition from previous section).
* But what if the account has associated records, which are not downloaded as they were not changed on the CRM?
The following section explains it.
Incremental linked sync filter in practice:
[[File:Syncfilter example.png]]
=== Example with linked sync filter disabled ===
Use case: '''Owner of an existing account is changed to the current user of the application.'''
'''Account''': the initial filter checks, whether there were some accounts changed since last synchronization. One account record was changed. This account record is downloaded to local database. After this step, the sync filter on account entity (checking whether account owner is the current user) applies to the currently downloaded record. It matches the filter and is kept in local database.
'''Contact''': the initial filter checks, whether there were some contacts changed since last synchronization. No contact records were changed on CRM side. No contact records are downloaded to local database.
But what if the account, now belonging to the current user, has contacts which may not be part of local database? It could happen, that some contacts were not downloaded, because they weren’t changed on server side since last synchronization and linked sync filter on contact entity isn’t checked during default Incremental Synchronization.
=== Example with linked sync filter enabled ===
Use case: '''Owner of an existing account is changed to the current user of the application.'''
'''Account''': The initial filter checks, whether there were some accounts changed since last synchronization. One account record was changed. This account record is downloaded to local database. After this step, the sync filter on account entity (checking whether account owner is the current user) applies to the currently downloaded record. It fits the filter and is kept in local database.
'''Contact''': The initial filter checks, whether there were some contacts changed since last synchronization. No contact records were changed on CRM side; '''however, we have incremental linked sync filter enabled for contact entity which results in checking linked filters as well'''.
Based on this linked filter, all contacts that have our downloaded account record set as parent record are downloaded into local database as well. In this moment, only those are kept, which have their parent account owner set to current user – linked filter’s conditions are completely fulfilled. It is certain that all related contacts are part of local database as well, even they were not changed since last synchronization.
=== Which entities should use linked sync filter? ===
Incremental linked sync filter should be enabled for the child entity – the entity, which has linked filter conditions stated in its Sync Filter.
If you use CRM server version 2013 SP1 or later, you can use the advantage of the linked filters, that will work not only on initial/full synchronization, but also on incremental synchronization. If not, from the incremental synchronization definition, only records, that are changed will be included.
== Use sync filter in online mode ==
If you want to ensure the same data in the application in online and offline mode, you can force using of the sync filter also in online mode. This can be configured for each mobile [[view]]; edit the properties of your view and enable '''Sync Filter - Use Sync Filter in Online Mode'''.
[[Category:Woodford]] [[Category:Synchronization]]
== Introduction ==
There are two types of synchronization: initial (full) synchronization, and incremental synchronization.
* Full synchronization is performed for example when the mobile app is used for the first time. In these cases, apps download data from the CRM server depending on the sync filter, so the sync filter is used to define what data is being downloaded to the Mobile CRM app's local database.
* In case of an incremental synchronization, the app downloads all records (that the user has permission for) that were created or updated since the last synchronization. Subsequently, the sync filters are used to only keep the records that follow the sync filters in the local database.
When setting up a Sync Filter, a condition can be defined for the CRM database entities (rows) which will be synced to your mobile device. Please keep in mind the capacity of mobile devices.
== Example ==
In this example, we set up a Sync Filter for opportunities that were created within the last 120 days.
# Edit an app project in Woodford.
# Select the entity '''Opportunity''' from the '''Project''' menu.
# Click '''Sync Filter'''.
# Define the filter:
#* Click '''Add condition'''. A default condition is created for '''Actual Close Date''', which is the first field of the entity, with the default operator '''Contains Data'''.
#* Click the field and select '''Created On''' from the dropdown menu.
#* Click the operator and select '''Last X Days''' from the dropdown menu.
#* Enter the number: 120.
# Click '''Save & Close'''.
== Incremental linked sync filters ==
Incremental linked sync filter, available for Dynamics CRM, ensures that linked filters on entities are checked during incremental synchronization. Without enabling it, the only initial filter for downloading records from server is the one checking whether the entity records were changed since last synchronization.
The use case for this filter is best shown on an example:
* The owner of an existing account is changed to the current user of the application, while the sync filters are set to only allow user-owned account to be stored in the offline database.
* As a result, the changed account record is downloaded (based on the incremental synchronization definition from previous section).
* But what if the account has associated records, which are not downloaded as they were not changed on the CRM?
The following section explains it.
Incremental linked sync filter in practice:
[[File:Syncfilter example.png]]
=== Example with linked sync filter disabled ===
Use case: '''Owner of an existing account is changed to the current user of the application.'''
'''Account''': the initial filter checks, whether there were some accounts changed since last synchronization. One account record was changed. This account record is downloaded to local database. After this step, the sync filter on account entity (checking whether account owner is the current user) applies to the currently downloaded record. It matches the filter and is kept in local database.
'''Contact''': the initial filter checks, whether there were some contacts changed since last synchronization. No contact records were changed on CRM side. No contact records are downloaded to local database.
But what if the account, now belonging to the current user, has contacts which may not be part of local database? It could happen, that some contacts were not downloaded, because they weren’t changed on server side since last synchronization and linked sync filter on contact entity isn’t checked during default Incremental Synchronization.
=== Example with linked sync filter enabled ===
Use case: '''Owner of an existing account is changed to the current user of the application.'''
'''Account''': The initial filter checks, whether there were some accounts changed since last synchronization. One account record was changed. This account record is downloaded to local database. After this step, the sync filter on account entity (checking whether account owner is the current user) applies to the currently downloaded record. It fits the filter and is kept in local database.
'''Contact''': The initial filter checks, whether there were some contacts changed since last synchronization. No contact records were changed on CRM side; '''however, we have incremental linked sync filter enabled for contact entity which results in checking linked filters as well'''.
Based on this linked filter, all contacts that have our downloaded account record set as parent record are downloaded into local database as well. In this moment, only those are kept, which have their parent account owner set to current user – linked filter’s conditions are completely fulfilled. It is certain that all related contacts are part of local database as well, even they were not changed since last synchronization.
=== Which entities should use linked sync filter? ===
Incremental linked sync filter should be enabled for the child entity – the entity, which has linked filter conditions stated in its Sync Filter.
If you use CRM server version 2013 SP1 or later, you can use the advantage of the linked filters, that will work not only on initial/full synchronization, but also on incremental synchronization. If not, from the incremental synchronization definition, only records, that are changed will be included.
== Use sync filter in online mode ==
If you want to ensure the same data in the application in online and offline mode, you can force using of the sync filter also in online mode. This can be configured for each mobile [[view]]; edit the properties of your view and enable '''Sync Filter - Use Sync Filter in Online Mode'''.
[[Category:Woodford]] [[Category:Synchronization]]