MongoDB provider

This sample provider demonstrates a "Pass-through" provider type that fetches wildfire location data from a MongoDB instance and exposes a feature service that displays point data. This sample implements geometry filtering, pagination, and aggregation operations, including returnCountOnly and returnExtentOnly. Click here to download the source code and dataset for the provider onto your developer machine.
Before you begin, you will need to setup your own MongoDB instance and populate it with the provided dataset. The data are found in data/wildfires.json.

How the Provider Works

This sample provider will read from a MongoDB instance that is populated with documents in the format below.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "type":"Feature",
    "properties": {
        "FIRE_ID":"OK3698209465619840221",
        "FIRE_TYPE":"Wildfire",
        "FIRE_NAME":"RESIDENT",
        "ACRES":1048
    },
    "geometry":{
        "type":"Point",
        "coordinates":[-94.65552802668105,36.98169475077668]
    }
}

Set up the Provider

1. Run the cdf createapp mongodb-app command to create a new custom data app or use an existing custom data app.
2. Run the cdf createprovider mongodb-provider command to create a custom data provider.
3. Copy the contents of the src folder in the provided source code into the src folder inside your providers/mongodb-provider/src directory.
4. Navigate to the providers/mongodb-provider directory in a command prompt and run the command:
   npm install @koopjs/geoservice-utils @synatic/noql config mongodb

Configure the Provider

1. In the cdconfig.json file, set the value of the properties.hosts field to false and properties.disableIdParam field to false. The file is located in the root of the mongodb-provider directory.

2. In the config/mongodb-provider directory, configure your MongoDB connection. It will look similar to this:

   Use dark colors for code blocksCopy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   {
       "mongodb": {
           "connectString": "mongodb://localhost:27017",
           "definedCollectionsOnly": true,
           "databases": {
               "sample-data": {
                   "fires": {
                       "geometryField": "location",
                       "idField": "_id",
                       "cacheTtl": 0,
                       "crs": 4326,
                       "maxRecordCount": 2000
                   }
               }
           }
       }
   }

Test the Provider

1. Navigate to the mongodb-app directory in a command prompt and run the npm start command to start the custom data app
2. In a web browser, navigate to http://localhost:8080/mongodb-provider/rest/services/sample-data::fires/FeatureServer/0/query and verify that the MongoDB provider is returning data points.

Build and Deploy the Custom Data Provider Package File

3. Stop the custom data app if it's running.
4. Open a command prompt and navigate to the custom data app directory.
5. Run the cdf export mongodb-provider command.
6. In a web browser, navigate to the ArcGIS Server Administrator Directory and sign in as an administrator.
7. Click uploads > upload.
8. On the Upload Item page, click Choose File and select the mongodb-provider.cdpk file. Optionally, provide a description in the Description text box.
9. Click Upload. Once the file is uploaded, you will be directed to a page with the following header: Uploaded item - <item_id> . Copy the item id.
10. Browse back to the root of the Administrator Directory and then click services > types > customdataproviders.
11. On the Registered Customdata Providers page, click register and paste the item id into the Id of uploaded item field.
12. Click Register.

Create Feature Service

1. Browse back to the root of the Administrator Directory and click services > createService.

2. On the Create Service page, copy and paste the following JSON into the Service (in JSON format) text box.

   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
   {
       "serviceName": "fires",
       "type": "FeatureServer",
       "description": "",
       "capabilities": "Query",
       "provider": "CUSTOMDATA",
       "clusterName": "default",
       "minInstancesPerNode": 0,
       "maxInstancesPerNode": 0,
       "instancesPerContainer": 1,
       "maxWaitTime": 60,
       "maxStartupTime": 300,
       "maxIdleTime": 1800,
       "maxUsageTime": 600,
       "loadBalancing": "ROUND_ROBIN",
       "isolationLevel": "HIGH",
       "configuredState": "STARTED",
       "recycleInterval": 24,
       "recycleStartTime": "00:00",
       "keepAliveInterval": 1800,
       "private": false,
       "isDefault": false,
       "maxUploadFileSize": 0,
       "allowedUploadFileTypes": "",
       "properties": {
           "disableCaching": "true"
       },
       "jsonProperties": {
           "customDataProviderInfo": {
               "dataProviderName": "mongodb-provider",
               "dataProviderHost": "",
               "dataProviderId": "sample-data::fires"
           }
       },
       "extensions": [],
       "frameworkProperties": {},
       "datasets": []
   }

3. Click Create.

Keep in mind that the provider code we used above assumes a database named sample-data and a collection named fires. If you used different names in your MongoDB instance, update the value of dataProviderId accordingly.

Consume Feature Service

To access the MongoDB feature service that you created in the previous section, use the appropriate URL (e.g., https://<domain_or_machine_name>/<webadaptor_name>/rest/services/fires/FeatureServer). You can use this URL to consume data from MongoDB in ArcGIS clients like ArcGIS Pro, ArcGIS Online, and ArcGIS Enterprise.