The following sections describe how to use sync to support common workflows:
Feature services can be published against your own ArcGIS Server or portal but can also be published to ArcGIS Online. In any case, you'll need to enable the sync capability of the feature services. Sync-enabled feature services allow ArcGIS clients to create local copies of the data and sync changes back and forth. If you're building feature services for offline use with ArcGIS Server, you'll need to prepare you geodatabase in advance . An option to enable sync by editing item properties is also provided in Portal for ArcGIS and ArcGIS.com for hosted feature services.
Setting up sync
A client begins using sync against a service by defining and downloading a replica using the createReplica operation. This returns data that the client can hold in a local database. The synchronizeReplica operation is used to synchronize subsequent changes made on the client with changes made on the server.
When defining a replica, clients specify the layers and the replica geometry. Features from the layers that intersect the replica geometry are included by default. Clients can also override the defaults and apply other criteria on a per-layer basis using layerQueries. For example, any one of the following can be applied for a layer using layerQueries:
- All features
- No features (for upload only)
- Features returned from a where clause
- Features intersecting the replica geometry and returned from a where clause
- Related features only
For non-spatial layers (tables), the default is to include related features only.
Filters such as the replica extent (geometry parameter) are set when a client calls the createReplica operation are used during synchronize. Only edits that satisfy the filters are kept in sync. If a client uploads an edit that no longer satisfies the filter during synchronize, the edit is applied to the server. However, if on the server. another edit is made to the feature where it is still outside the filters, the edit is not downloaded to the client during the next synchronize. In this case, the feature is out of sync on the client and the server. There are also cases where features edited outside the filters are removed from the client on download during synchronize. To ensure all features are kept in sync, clients should set filters when calling createReplica that cover all intended edits.
Clients can choose the data format of the results. Data formats can be in either JSON or SQLite. Runtime clients are designed to work where the data format is set to SQLite.
If layers have attachments, clients choose whether or not to include the attachments in the replica. If attachments are not included, the createReplica and synchronizeReplica operations will not transfer attachments. If attachments are included and the data format is SQLite, they will be provided in the SQLite geodatabase. If the data format is JSON, they can be referenced by URL in the result or embedded in the result. If referenced by URL, clients can subsequently download the attachments and store them locally.
Clients also choose a sync model when defining a replica. The syncModel parameter defines how layers can be synced.
In some cases, clients already have a copy of the data they want to edit and keep in sync with the server. Replica options can be set so that the local data can be used when defining the replica. When replica options are set, the createReplica operation registers a replica on the server and returns metadata for the client to persist with the local data. Example 3 in workflow examples describes this process.
The createReplica operation also allows clients to set a replica name. The replica name is not required but allows clients to apply a user-friendly name to the replica.
Clients can set the replica spatial reference to define the spatial reference of the output features. By default, the spatial reference of the service is used.
If the replica includes a lot of data, the client may want to run asynchronously to avoid server timeouts. This can be done by setting the async parameter provided in the createReplica operation. If the data format is JSON, clients can also set the transportType parameter to have the results returned embedded in the response or via a reference URL. If using a referenced URL, clients can download the results and store them locally. If the data format is SQLite, the response is always via a reference URL.
If the data format is JSON, clients are required to store and maintain a local copy of the data. Clients can choose the manner in which data is maintained (for example, a local database) as long as it's consistent with the data from the feature service. For example, a layer's string field in the local copy must match the corresponding layer's string field in the feature service to maintain consistency on sync. To ensure consistency, clients can use the information provided by the feature service. Field lists and field types, for example, are described in the feature service's layer and table resources.
If the data format is JSON, clients are also required to store and maintain the replica metadata that's needed when the client runs sync. Replica metadata returned from the createReplica operation includes the following:
- replicaID—A value (GUID) that uniquely identifies the replica. Must be provided when running sync.
- syncModel—The sync model (perReplica or perLayer).
- If the syncModel is perReplica, the replica metadata includes a replicaServerGen. The replicaServerGen identifies the last time changes were received by the client.
- If the syncModel is perLayer, the replica metadata has layerServerGens. layerServerGens includes a serverGen for each layer in the replica. A serverGen identifies the last time changes were received by the client for a specific layer.
- The replicaServerGen and serverGen values are integers that can represent a time stamp or date.
Once the setup process is complete, clients are ready to start making local edits and begin syncing.
To sync, a client runs the synchronizeReplica operation. The operation allows clients to apply local edits to the server and, in response, get any changes that have occurred on the server since the last sync. The sync is complete when the client incorporates the changes from the server into the local database and updates its replica metadata. The client can then make additional local edits that can be synchronized in the same way at a later time.
When syncing, the client provides the replicaID to identify the replica to be synced on the server. The server uses replica metadata to determine the changes to send back to the client. For example, if a replica is defined to include all features intersecting the replica geometry, synchronizeReplica will only return changes to features intersecting the replica geometry.
The client also provides a syncDirection that describes whether to upload, download, or both upload and download on sync. Read-only clients always set the syncDirection to download.
Before setting the syncDirection, the client needs to check the replica's syncModel.
If the syncModel is perReplica, the syncDirection applies to all layers in the replica. A perReplica sync model also requires the client to provide the replicaServerGen on sync. The replicaServerGen tells the server the point in time from which to send back changes.
If the syncModel is perLayer, the client sets the syncDirection on a layer-by-layer basis. For example, one layer can upload changes while another downloads during sync. A perLayer syncModel also allows clients to limit the sync to only the layers specified. For each layer involved in the sync, the client must also provide a serverGen. The serverGen tells the server the point in time from which to send back changes for a specific layer.
When sync involves an upload, clients provide the edits to be uploaded. The edits include inserts, updates, and deletes and, if applicable, references to attachments. If the data format is JSON, clients can pre-upload the attachments and reference them with the edits by URL. If the data format is SQLite, attachments are embedded in the delta SQLite.
Edits must include globalID values. GlobalIDs are used to identify the features on the server to which the updates and deletes apply. For inserts, clients must also generate and provide globalIDs. When inserts are applied, the server preserves the globalID value provided by the client. Clients can ask the server to return the objectIDs of the inserts as applied on the server. This is needed if the client has to map the server's objectIDs to the client's objectIDs.
The service does checks on the edits provided by the client prior to applying them. Edits that do not pass the checks are not applied, and information about them is returned to the client. The client can correct the data and reapply on the next sync. The rollbackOnFailure parameter can be used to determine how the feature service responds to an error during sync.
Edits are applied using a last-in-wins policy. Edits from the client overwrite the edits made on the server on sync.
When sync involves a download, edits are returned to the client. Clients are to apply the edits to the local database. Clients can set the data format of the edits to be either JSON or SQLite.
If the data format is SQLite, a client can have the edits returned embedded in the response or by reference URL. If reference URL, clients can download the edits from the location provided. If attachments are included, clients can also have the attachments embedded with the edits or referenced by URL. If referenced by URL, clients can download the attachments and apply them to the local database.
If the data format is SQLite, responses are always returned via URL with the attachments embedded in the response.
The edits included in the download are determined based on the criteria defined when setting up the sync. For consistency, it is also recommended that clients upload edits based on the same criteria. The server, however, will apply edits provided by the client that are outside the criteria.
Clients can run sync with an asynchronous process. When a process is run asynchronously, clients periodically check to see if the process is complete as it's running. When complete, clients can get the result. Running a process in this mode is recommended when server timeouts are a concern.
Updates to the replica metadata are also returned during sync. Clients are required to persist the metadata updates locally. These updates ensure that the next sync operation returns the appropriate response.
If the sync fails and a response is not received, the client can call sync again, passing in the same parameter values. The server will include anything that was lost in the previous sync in the response.
Unregistering a replica
The unRegisterReplica operation is used to remove replica metadata from the server. Once the metadata is removed for a specific replica, the client will no longer be able to sync using the replica. Administrators can run this command to clean up older replicas. A client can also use this operation when it no longer needs to sync. The Replicas resource lists the replicas associated with the feature service.
It's also possible for a client to specify that the replica be unregistered as part of the last sync. However, it's recommended that clients call the unRegisterReplica operation separately instead of unregistering with the last sync. This allows a client to check that the last sync completed successfully before calling unregister.
Users that have permissions to access a sync-enabled feature service can use the Sync API. The user that executes the createReplica operation is assigned ownership in the replica metadata. This includes authenticated users and anonymous users.
Replicas owned by authenticated users can only be accessed by the owner or the admin user. Consequently, only owners and admin users can sync or unregister the replica. Replicas owned by anonymous users can be accessed by anyone who has access to the service. This includes the admin user, authenticated users, or others connecting as anonymous. Users do not need to have access to the reference replica specified when running createReplica with the replicaOptions parameter.
The data access rules enforced through ownership-based access control on the feature service apply to the Sync API as well. For example, if access control does not allow edits to features owned by others, a user will not be able to sync edits to features owned by others.