Edit and sync features with feature service

Synchronize offline edits with a feature service.

Use case

A survey worker who works in an area without an internet connection could take a geodatabase of survey features offline at their office, make edits and add new features to the offline geodatabase in the field, and sync the updates with the online feature service after returning to the office.

How to use the sample

Pan and zoom into the desired area, making sure the area you want to take offline is within the current extent of the map view. Tap on the "Generate Geodatabase" button to take the area offline. When complete, the map will update with a red outline around the offline area. To edit features, tap to select a feature, and tap again anywhere else on the map to move the selected feature to the tapped location. To sync the edits with the feature service, click the "Sync geodatabase" button.

How it works

1. Create a GeodatabaseSyncTask from a URL to a feature service.
2. Use createDefaultGenerateGeodatabaseParameters() on the geodatabase sync task to create GenerateGeodatabaseParameters, passing in an Envelope extent as the parameter.
3. Create a GenerateGeodatabaseJob from the GeodatabaseSyncTask using createGenerateGeodatabaseJob(...) passing in parameters and a path to the local geodatabase.
4. Start the job and get the result Geodatabase.
5. Load the geodatabase and get its feature tables. Create feature layers from the feature tables and add them to the map's operational layers collection.
6. Create SyncGeodatabaseParameters and set the sync direction.
7. Create a SyncGeodatabaseJob from GeodatabaseSyncTask using .createSyncGeodatabaseJob(...) passing in the parameters and geodatabase as arguments.
8. Start the sync job to synchronize the edits with syncGeodatabaseJob.start().

Relevant API

• FeatureLayer
• FeatureTable
• GenerateGeodatabaseJob
• GenerateGeodatabaseParameters
• GeodatabaseSyncTask
• SyncGeodatabaseJob
• SyncGeodatabaseParameters
• SyncLayerOption

Additional information

This sample uses the GeoViewCompose Toolkit module to be able to implement a Composable MapView.

Tags

feature service, geodatabase, geoviewcompose, offline, synchronize

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/* Copyright 2024 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.esri.arcgismaps.sample.editandsyncfeatureswithfeatureservice

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.editandsyncfeatureswithfeatureservice.screens.MainScreen

class MainActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // authentication with an API key or named user is
        // required to access basemaps and other location services
        ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)

        setContent {
            SampleAppTheme {
                SampleApp()
            }
        }
    }

    @Composable
    private fun SampleApp() {
        Surface(
            color = MaterialTheme.colorScheme.background
        ) {
            MainScreen(
                sampleName = getString(R.string.edit_and_sync_features_with_feature_service_app_name)
            )
        }
    }
}