Upgrading Custom Data Feeds

Upgrade a server machine

The process for upgrading custom data feeds is different depending on whether you are upgrading to ArcGIS Enterprise 12.0 from 11.x or whether you are upgrading within the 11 series. Follow the appropriate topic below.

Upgrading to ArcGIS Enterprise 12

Follow these steps to upgrade ArcGIS Server Custom Data Feeds installed on a server machine. Only compatible registered custom data providers will be automatically re-registered on your upgraded machine. Read below for general details and then read this special topic on recompiling your custom data providers for ArcGIS Enterprise 12.0.

Perform the upgrade

Follow the general ArcGIS Enteprise upgrade instuctions. The ArcGIS Custom Data Feeds Runtime is now included in base ArcGIS Enterprise deployments and in stand-alone ArcGIS Server deployments. There is no separate upgrade of the CDF runtime required when upgrading to ArcGIS Server 12.0 from 11.x.

Assess the current state of your providers and services

1. After the upgrade is complete, review the ArcGIS Server Logs and any custom data feature services you had deployed prior to the upgrade.
   • Any custom data feature services that are in a "stopped" state indicates that the custom data provider associated with the service contained the unuspported config module.
   • The ArcGIS Server logs will have a WARNING level message for each unsupported custom data provider as follows:

   Custom data provider <name> uses unsupported 'config' module. See the Esri Developer's documentation for migration details.

Update providers and restart stopped services

1. The custom data package files (.cdpk files) for each unsupported provider were archived in your chosen configuration store location. By default, this location is <ArcGIS Server installation drive>\arcgisserver\config-store. You can retrieve the archived code from the config store if you do not have access to the original source code used to create the .cdpk file. You can use an archiver such as 7-zip to open the .cdpk(s).
2. Using the ArcGIS Enterprise SDK 12.0 custom data feeds CLI, follow the topics for creating a custom data app and creating a custom data provider. If you wish to use this new provider to restart one of the stopped services, give your custom data provider a name identical to the name of the unsupported provider you are replacing . If you are going to create a new service, the new provider name does not have to match the old provider name.
3. Move all of the source code from your old provider to the newly created provider. This includes your model.js and any helper files that your provider uses.
   • Do not copy over your provider's /config/default.json file. You will create a new file in your project and require this new file in your code as needed to handle any configurable parameters. See this topic on provider configuration for details.
   • Do not copy over your provider's cdconfig.json file. You will update the cdconfig.json file that has been created in your new project. See this topic on creating service parameters for details.
4. In your model.js wherever the code references the host and id parameters, replace host and id with the new key names from your service parameters.
5. Please read this special topic on recompiling your custom data providers for ArcGIS Enterprise 12.0. It provides full details for making the changes listed above and uses examples from the official custom data feeds sample providers.

Upgrading Within ArcGIS Enterprise 11

Follow these steps to upgrade ArcGIS Server Custom Data Feeds installed on a server machine. Any registered custom data providers will be automatically re-registered on your upgraded machine.

1. Upgrade ArcGIS Server on the server machine to the desired version.
2. Stop ArcGIS Server.
   • In Windows, use the Computer Management tool.
   • In Linux, run the stopserver.sh script in the /arcgis/server directory.
3. Uninstall the ArcGIS Server Custom Data Feeds runtime.
   • In Windows, use the Control Panel.
   • In Linux, run the uninstall_CustomDataFeed.sh script.
4. Install the same version of ArcGIS Server Custom Data Feeds Runtime that matches the version of ArcGIS Server on your server machine. If your ArcGIS Server site includes multiple machines, install the ArcGIS Server Custom Data Feeds Runtime on each machine.

Upgrade a development machine

Follow these steps to upgrade ArcGIS Server Custom Data Feeds on a development machine:

1. Ensure that the version of Node.js on your development machine is compatible with the version of the ArcGIS Enterprise SDK you wish to upgrade to. For compatibility details, see the Installing and Configuring topic.

2. Execute the ArcGIS Enterprise SDK setup:

   • In Windows, run the setup and follow the prompts.
   • In Linux, execute the setup with the command ./Setup -m silent -l yes -c yes. The -c yes flag indicates you want to install the Custom Data Feeds command line tool.

   In both environments, the installer will recognize this process as upgrade and uninstall the previous version of the SDK.