Local Server feature layer

View on GitHub
Sample viewer app

Start a local feature service and display its features in a map.

screenshot

Use case

For executing offline geoprocessing tasks in your ArcGIS Runtime apps via an offline (local) server.

How to use the sample

A Local Server and Local Feature Service will automatically be started. Once started then a FeatureLayer will be created and added to the map.

How it works

  1. Create and run the Local Server.
    • LocalServer::instance creates the Local Server.
    • LocalServer::start() starts the server asynchronously.
  2. Wait for server to be in the LocalServerStatus::Started state.
    • LocalServer::statusChanged() fires whenever the running status of the Local Server changes.
  3. Create and run a local service. For example, to run a LocalMapService:
    • new LocalFeatureService(Url) creates a local feature service with the given URL path to the map package (mpkx file).
    • LocalFeatureService::start() starts the service asynchronously.
    • The service is added to the Local Server automatically.
  4. Wait for feature service to be in the LocalServerStatus::Started state.
    • LocalFeatureService::statusChanged() signal fires whenever the status of the Local Service changes.
  5. Create a feature layer from local feature service.
    • Create a ServiceFeatureTable(Url) from local feature service URL, LocalFeatureService::url().
    • Create a FeatureLayer using the service feature table.
    • Add the feature layer to the map's operational layers.
    • Connect to the feature layer's LoadStatusChanged signal.
    • When the feature layer's status is Loaded, set the map view's extent to the layer's full extent.

Relevant API

  • FeatureLayer
  • LocalFeatureService
  • LocalFeatureService::statusChanged
  • LocalServer
  • LocalServerStatus

Offline Data

Read more about how to set up the sample's offline data here.

Link Local Location
PointsOfInterest Pro Map Package <userhome>/ArcGIS/Runtime/Data/mpkx/PointsofInterest.mpkx

Additional information

Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.

Tags

feature service, local, offline, server, service

Sample Code

LocalServerFeatureLayer.cppLocalServerFeatureLayer.cppLocalServerFeatureLayer.hLocalServerFeatureLayer.qml
Use dark colors for code blocksCopy
                                                                                                                                                                           
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// [WriteFile Name=LocalServerFeatureLayer, Category=LocalServer]
// [Legal]
// Copyright 2017 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.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

#include "LocalServerFeatureLayer.h"

#include "Basemap.h"
#include "MapQuickView.h"
#include "Map.h"
#include "LocalServer.h"
#include "LocalFeatureService.h"
#include "ServiceFeatureTable.h"
#include "FeatureLayer.h"
#include "Viewpoint.h"

#include <QDir>
#include <QTemporaryDir>
#include <QFile>

using namespace Esri::ArcGISRuntime;

LocalServerFeatureLayer::LocalServerFeatureLayer(QQuickItem* parent) :
  QQuickItem(parent)
{
  // Create a temporary directory for the local server if one has not already been created
  if (!LocalServer::appDataPath().isEmpty() && !LocalServer::tempDataPath().isEmpty())
    return;

  // create temp/data path
  const QString tempPath = LocalServerFeatureLayer::shortestTempPath() + "/EsriQtTemp";

  // create the directory
  m_tempDir = std::make_unique<QTemporaryDir>(tempPath);

  // set the temp & app data path for the local server
  LocalServer::instance()->setTempDataPath(m_tempDir->path());
  LocalServer::instance()->setAppDataPath(m_tempDir->path());
}

LocalServerFeatureLayer::~LocalServerFeatureLayer() = default;

void LocalServerFeatureLayer::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<LocalServerFeatureLayer>("Esri.Samples", 1, 0, "LocalServerFeatureLayerSample");
}

void LocalServerFeatureLayer::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");
  m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);

  // Create a map using the topographic BaseMap
  m_map = new Map(BasemapStyle::ArcGISTopographic, this);

  // Set map to map view
  m_mapView->setMap(m_map);

  // Check for ArcGIS Pro map package files
  const QString fileName = "PointsofInterest.mpkx";
  const QString dataPath = QDir::homePath() + "/ArcGIS/Runtime/Data/mpkx/" + fileName;

  // Check to see if map package exists
  if (!QFile::exists(dataPath))
  {
    qDebug() << "ArcGIS Pro .mpkx file not found at" << dataPath;
  }

  // create a feature service
  m_localFeatureService = new LocalFeatureService(dataPath, this);

  if (LocalServer::instance()->isInstallValid())
  {
    connectSignals();
    if (LocalServer::status() == LocalServerStatus::Started)
    {
      qDebug() << "Local server was already running";

      // The local server can already be running if it was started in a different application.
      // We start up the local feature service here because there will be no status change signal to otherwise trigger it.

      startFeatureService();
    }
    else if (LocalServer::status() != LocalServerStatus::Starting)
    {
      LocalServer::start();
    }
  }
  else
    qDebug() << "Local server install invalid";
}

void LocalServerFeatureLayer::connectSignals()
{
  // Local server status
  connect(LocalServer::instance(), &LocalServer::statusChanged, this, [this]()
  {
    // If the local server was not previously running, our local feature service will start here if the local server has successfully started.
    if (LocalServer::status() == LocalServerStatus::Started)
    {
      startFeatureService();
    }
  });

  // local feature service status
  connect(m_localFeatureService, &LocalFeatureService::statusChanged, this, [this]()
  {
    if (m_localFeatureService->status() == LocalServerStatus::Starting)
    {
      qDebug() << "Local feature service starting up";
    }
    else if (m_localFeatureService->status() == LocalServerStatus::Started)
    {
      qDebug() << "Successfully hosting local feature service at:" << m_localFeatureService->url().toString();

      // create the feature layer
      ServiceFeatureTable* svt = new ServiceFeatureTable(QUrl(m_localFeatureService->url().toString() + "/0"), this);
      FeatureLayer* featureLayer = new FeatureLayer(svt, this);
      connect(featureLayer, &FeatureLayer::loadStatusChanged, this, [this, featureLayer](LoadStatus status)
      {
        if (status == LoadStatus::Loaded)
        {
          m_mapView->setViewpoint(Viewpoint(featureLayer->fullExtent()));
        }
      });
      m_map->operationalLayers()->append(featureLayer);
    }
    else if (m_localFeatureService->status() == LocalServerStatus::Failed)
    {
      qDebug() << "Local feature service failed to start";
    }
  });
}

void LocalServerFeatureLayer::startFeatureService() const
{
  if (m_localFeatureService->status() != LocalServerStatus::Started || m_localFeatureService->status() != LocalServerStatus::Starting)
    m_localFeatureService->start();
}

QString LocalServerFeatureLayer::shortestTempPath()
{
  // get tmp and home paths
  const QString tmpPath = QDir::tempPath();
  const QString homePath = QDir::homePath();

  // return whichever is shorter, temp or home path
  if (homePath.length() > tmpPath.length())
    return tmpPath;
  else
    return homePath;
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.