Skip to main content

Upgrade ArcGIS Data Pipelines Server

Upgrading ArcGIS Data Pipelines Server provides your organization with the latest software features and improvements.

The ArcGIS Data Pipelines Server setup package detects whether a previous version of ArcGIS Data Pipelines Server is installed on your machine. If one is found, the setup package can upgrade the software to the new version.

ArcGIS Data Pipelines Server uses an in-place upgrade process, so you do not need to uninstall and reinstall the software. The site will be unavailable during the upgrade, and users will be unable to access it until the upgrade is complete.

Follow the steps below to upgrade ArcGIS Data Pipelines Server.

Prepare to upgrade ArcGIS Data Pipelines Server

Before upgrading, carefully review the following information:

  • Before upgrading, confirm that you can access the required setup and authorization files in My Esri.

  • For ArcGIS Data Pipelines Server to function correctly, its version must match the version of the ArcGIS Enterprise deployment with which it is federated. It is required to upgrade your ArcGIS Enterprise base deployment before upgrading ArcGIS Data Pipelines Server.

  • Do not unfederate your ArcGIS Data Pipelines Server site from ArcGIS Enterprise or remove its designation as the Data Pipelines Server role at any point during the upgrade process.

  • The Windows service account for your ArcGIS Data Pipelines Server site (its Run As account) must remain the same when upgrading.

Upgrade a multiple-machine site

If you have a multiple-machine ArcGIS Data Pipelines Server site, you must upgrade each machine in the site. The machines must be upgraded sequentially, waiting until the upgrade is complete on one machine before starting the upgrade on the next. Each ArcGIS Data Pipelines Server machine in the site must be at the same version and use the same license.

If you have a single-machine site and want to expand your ArcGIS Data Pipelines Server site to multiple machines after upgrading, follow the steps to join additional machines to the site after the upgrade is complete.

Upgrade using the setup program

When upgrading using the Setup.exe file, you must specify the credentials for the ArcGIS Data Pipelines Server account currently used by the software. Typically, this is the account you defined when installing the software. If the account has changed since you installed, for example, by using the configureserviceaccount utility, you must provide the username and password you designated when modifying the account.

If you do not specify the ArcGIS Data Pipelines Server account, or it does not match the ArcGIS Data Pipelines Server account used by your current installation, the installation process displays a message indicating that the credentials could not be validated.

If you are unsure of the password for the ArcGIS Data Pipelines Server account, contact your system administrator or reset your password using the configureserviceaccount utility. For more information, see ArcGIS Data Pipelines Server account.

To upgrade using the setup program, complete the following steps for each machine in the ArcGIS Data Pipelines Server site:

  1. Browse to the location of the setup files and double-click Setup.exe.

  2. During the installation, read the master agreement and accept it, or close the installation window if you do not agree with the terms.

  3. On the next dialog box, either specify the account login credentials or provide a configuration file.

    The ArcGIS Data Pipelines Server account used by your existing installation is prepopulated in the ArcGIS Data Pipelines Server Account box. Provide the password for the ArcGIS Data Pipelines Server account. Typically, this is the password you defined when installing the software.

    If you provide a configuration file, the credentials in the server configuration file must be the same credentials used by your existing ArcGIS Data Pipelines Server site.

  4. If you selected Specify the account name and password and manually entered the ArcGIS Data Pipelines Server account information, choose whether to export a server configuration file. If you do not want to export a configuration file, click Next, and accept the default Do not export configuration file option. If you want to export a server configuration file for future installations, select Export configuration file. Browse to a secure folder and provide a name for the configuration file.

  5. The following are reasons you may want to export a server configuration file:

    • Create the same ArcGIS Data Pipelines Server account when installing on multiple machines.

    • Store the account for use when upgrading to a newer version.

    • Perform a silent installation in which the username and password are encrypted.

    Caution:

    When exporting a server configuration file to a network share, the Local System account on the machine where ArcGIS Data Pipelines Server is being installed must have write permissions to the network share. If the permissions are not set, the server configuration file may not export successfully. If you're unsure how to correctly set permissions for the network share, contact your system administrator, or export the server configuration file locally and copy it to the network share.

  6. Follow the directions on screen to complete the installation.

  7. After installation is complete, use the software authorization wizard to reauthorize ArcGIS Data Pipelines Server with a new license file.

    After reauthorization is complete, the configuration wizard opens in a browser.

  8. Follow the instructions in the configuration wizard to complete the upgrade process.

  9. For a multiple-machine ArcGIS Data Pipelines Server site, repeat the steps above for each machine participating in the site. The Data Pipelines Server endpoint will be available after all machines in the site have been upgraded.

  10. Once all machines in the site are upgraded, proceed with the post-upgrade steps to finish upgrading your deployment.

  1. From the command prompt, run the ArcGIS Data Pipelines Server setup script as the same user that installed the existing earlier version, for example, <untar directory>/Setup.

    You do not need to stop ArcGIS Data Pipelines Server before running this script.

    The setup detects your existing earlier version of ArcGIS Data Pipelines Server on the machine and prompts you to continue or exit the upgrade.

  2. Type y and press Enter to accept the detected settings and continue with the upgrade.

    Note:

    Wait while ArcGIS Data Pipelines Server is upgraded. This may take several minutes.

  3. After installation is complete, use the software authorization wizard to reauthorize ArcGIS Data Pipelines Server with a new license file.

    After reauthorization is complete, the configuration wizard opens in a browser.

  4. Follow the instructions in the configuration wizard to complete the upgrade process.

  5. For a multiple-machine ArcGIS Data Pipelines Server site, repeat the steps above for each machine participating in the site. The Data Pipelines Server endpoint will be available after all machines in the site have been upgraded.

  6. Once all machines in the site are upgraded, proceed with the post-upgrade steps to finish upgrading your deployment.

Upgrade silently

When upgrading using the Setup.exe file, you must specify the credentials for the ArcGIS Data Pipelines Server account currently used by the software. Typically, this is the account you defined when installing the software. If the account has changed since you installed, for example, by using the configureserviceaccount utility, you must provide the username and password you designated when modifying the account.

If you do not specify the ArcGIS Data Pipelines Server account, or it does not match the ArcGIS Data Pipelines Server account used by your current installation, the installation process displays a message indicating that the credentials could not be validated.

If you are unsure of the password for the ArcGIS Data Pipelines Server account, contact your system administrator or reset your password using the configureserviceaccount utility. For more information, see ArcGIS Data Pipelines Server account.

To upgrade silently, complete the following steps for each machine in the ArcGIS Data Pipelines Server site:

  1. From the command prompt, run the ArcGIS Data Pipelines Server setup silently. Specify the username and password of the ArcGIS Data Pipelines Server account and agreement with the Esri Master Agreement.

    In the following example, the ArcGIS Data Pipelines Server account used by the software is myaccount and the password is mypassword.

    <path to ArcGIS Data Pipelines Server setup download folder>\Setup.exe /qb USER_NAME=myaccount PASSWORD=mypassword ACCEPTEULA=yes

  2. After the installation completes, you must reauthorize ArcGIS Data Pipelines Server with a new license file. You can access your new authorization files in My Esri. You can authorize your software later, but you must complete this workflow in order to use your upgraded ArcGIS Data Pipelines Server site.

    To reauthorize silently, use the following command:

    <ArcGIS Data Pipelines Server installation>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /S /Ver <version number> /LIF <full path of authorization file, including name and extension>

    To reauthorize using the software authorization wizard, see reauthorize ArcGIS Data Pipelines Server.

  3. Upgrade the site using the upgradesite command line utility. This utility has the following parameters:

    • -s—When included in the command, this prompts the utility to run the upgrade. The upgrade won't run without -s. This is intended as a safeguard to ensure you only run the upgrade when you're ready.

    • h—This displays the help for the tool. When the command is run without -s, the help also displays.

    • r—The recovery codes file used to generate the site invariant keys.

    By default, the upgradesite utility can be found at <ArcGIS Data Pipelines Server installation>\tools\upgradesite\upgradesite.bat.

  4. For a multiple-machine ArcGIS Data Pipelines Server site, repeat the steps above for each machine participating in the site.

  5. Once all machines in the site are upgraded, proceed with the post-upgrade steps to finish upgrading your deployment.

To upgrade silently, complete the following steps for each machine in the ArcGIS Data Pipelines Server site:

  1. From the command prompt, use the following command to run the ArcGIS Data Pipelines Server setup. This must be run as the same user that installed the existing earlier version.

    <untar directory>/Setup -m silent -l yes

  2. After the upgrade has completed, use the following command to reauthorize the ArcGIS Data Pipelines Server software:

    <ArcGIS Data Pipelines Server install directory>/tools/authorizeSoftware -f <full path to the license file>

    For more information, see Authorize your software.

  3. Upgrade the site using the upgradesite command line utility. This utility has the following parameters:

    • -s—When included in the command, this prompts the utility to run the upgrade. The upgrade won't run without -s. This is intended as a safeguard to ensure you only run the upgrade when you're ready.

    • h—This displays the help for the tool. When the command is run without -s, the help also displays.

    • r—The recovery codes file used to generate the site invariant keys.

    By default, the upgradesite utility can be found at <<ArcGIS Data Pipelines Server install directory>/tools/upgradesite/upgradesite.sh.

  4. For a multiple-machine ArcGIS Data Pipelines Server site, repeat the steps above for each machine participating in the site.

  5. Once all machines in the site are upgraded, proceed with the post-upgrade steps to finish upgrading your deployment.

Post-upgrade steps

After the upgrade is complete, you may need to perform the following tasks depending on your ArcGIS Enterprise deployment and organizational needs:

  1. If you configured ArcGIS Web Adaptor to work with ArcGIS Data Pipelines Server, you must use an upgraded version of ArcGIS Web Adaptor as well.

    1. Uninstall the ArcGIS Web Adaptor used for the ArcGIS Data Pipelines Server site. Be sure to note the name of the Web Adaptor before you uninstall it. For full instructions, see the uninstallation topic for IIS or Java (Windows).

    2. Install the ArcGIS Web Adaptor that will be used for the ArcGIS Data Pipelines Server site. Ensure that you use the Web Adaptor name that you used in the previous version. For full instructions, see the installation topic for IIS or Java (Windows).

    3. Configure the ArcGIS Web Adaptor with the ArcGIS Data Pipelines Server site. For full instructions, see the configuring topic for IIS or Java (Windows).

    4. Uninstall the ArcGIS Web Adaptor used for the ArcGIS Data Pipelines Server site. Be sure to note the name of the Web Adaptor before you uninstall it. For full instructions, see the uninstallation topic for Java (Linux).

    5. Install the ArcGIS Web Adaptor that will be used for the ArcGIS Data Pipelines Server site. Ensure that you use the Web Adaptor name that you used in the previous version. For full instructions, see the installation topic for Java (Linux).

    6. Configure the ArcGIS Web Adaptor with the ArcGIS Data Pipelines Server site. For full instructions, see the configuring topic for Java (Linux).

  2. Continue upgrading any remaining ArcGIS Enterprise components as needed. For more information, see Upgrade ArcGIS Enterprise.

  3. If you registered database data stores in the previous version, such as SQL Server, PostgreSQL, Snowflake or other database data stores, you may need to upgrade them before using them with ArcGIS Data Pipelines.

    For more information on how to upgrade database data store items, see Upgrade database data store items.

    With the above completed, you are now able to use the upgraded data stores as input data sources for your data pipeline workflows.