Installing and Configuring Custom Data Feeds

Setup a server machine

1. Install ArcGIS Server on your server machine and create an ArcGIS Server site.

2. Install the same version of ArcGIS Server Custom Data Feeds Runtime as the version ArcGIS Server on your server machine. If there are multiple machines in your ArcGIS Server site, then the ArcGIS Server Custom Data Feeds Runtime must be installed on each machine.

3. Refer to the table below for the version of Node.js included with each ArcGIS Server version:

   Product	Version	Node.js version	Notes
   ArcGIS Server	11.1	16.19.1	ArcGIS Server 11.1 ships with Node.js v16.19.1
   ArcGIS Server	11.2	18.17.0	ArcGIS Server 11.2 ships with Node.js v18.17.1
   ArcGIS Server	11.3	20.11.1	ArcGIS Server 11.3 ships with Node.js v20.11.1
   ArcGIS Server	11.4	20.17.0	ArcGIS Server 11.4 ships with Node.js v20.17.0

Setup a development machine

1. Install ArcGIS Enterprise SDK on your development machine. The Custom Data Feeds (CDF) command line tool is included in the ArcGIS Enterprise SDK as an optional installation option. During installation, you will be prompted by the Windows or Linux installer to install Custom Data Feeds.

   It is highly recommended that your development machine and server machine run the same operating system and the same version of Node.js. Note that the development machine does not need to have ArcGIS Enterprise or ArcGIS Server installed.

2. Refer to the table below for compatible Node.js versions for each version of ArcGIS.

   Product	Version	Node.js version(s)	Notes
   ArcGIS Enterprise SDK (CDF CLI)	11.1	14.13.1 - 16.19.1	Any Node.js version in this range is suitable.
   ArcGIS Enterprise SDK (CDF CLI)	11.2	16.16.2 - 18.17.0	Any Node.js version in this range is suitable.
   ArcGIS Enterprise SDK (CDF CLI)	11.3	18.17.1 - 20.11.1	Any Node.js version in this range is suitable.
   ArcGIS Enterprise SDK (CDF CLI)	11.4	18.17.1 - 20.17.0	Any Node.js version in this range is suitable.

   If you need to maintain different versions of Node.js on your development machine, consider using NVM on Linux or NVM for Windows. Note that you should use either NVM or a direct Node.js installation. Installing Node.js with the prebuilt installer alongside NVM can lead to CLI issues.

3. Open a command prompt on your development machine, and run the command: cdf -h. If the CLI tool is properly installed, you should see the expected output below:

   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
   Usage : cdf <command> [options]
   
   Commands:
     cdf createapp <name>                              creates a new custom data app
     cdf createprovider <name>                         creates a new custom data provider within custom
                                                       data app
     cdf listproviders                                 lists custom data providers registered with
                                                       custom data app
     cdf export <name>                                 exports specified custom data provider into
                                                       package file with .cdpk extension
     cdf deleteprovider <name>                         deletes specified custom data provider from
                                                       custom data app
     cdf register <name> <server-admin-url> <token>    registers a provider with ArcGIS server
     cdf unregister <name> <server-admin-url> <token>  unregisters a provider with ArcGIS server and
                                                       optionally deletes associated services
   
   Options:
     -h, --help     Show help                                                                 [boolean]
     -v, --version  Show version number                                                       [boolean]
   
   Esri - copyright 2024