Install Insights in ArcGIS Enterprise

To install and configure ArcGIS Insights in ArcGIS Enterprise, you need to have elevated privileges in a deployment environment.

At a minimum, to run the installation, you must have installed Portal for ArcGIS and ArcGIS Server, either on the same machine or separately in a distributed environment. A full base ArcGIS Enterprise deployment is required to use Insights in ArcGIS Enterprise.

The setup program detects whether Portal for ArcGIS or ArcGIS Server is installed on your machine and then installs the appropriate Insights feature. On a single-machine deployment, you only need to run the setup once. If your Portal for ArcGIS is configured as highly available, you need to run the setup program on both portal machines. If your ArcGIS Server site is a multimachine site, you need to run the setup program on all of the machines in the ArcGIS Server site.

If neither Portal for ArcGIS nor ArcGIS Server is detected, the program closes.

Windows

Use the following sections to download, install, and uninstall on Windows:

• Download the installation package
• Run the installation program
• Uninstall Insights in ArcGIS Enterprise

Download the installation package

The Insights in ArcGIS Enterprise installation program has two installation features:

• Insights client application on Portal for ArcGIS
• ArcGIS Server component of Insights

Complete the following steps to download the installation package for Windows:

1. Sign in to the My Esri site with your Esri account that is associated with your customer number.
2. Go to My Organization and click Downloads.

   All the software downloads that are available to you (based on your customer number) are displayed.

3. Locate ArcGIS Insights among the products.

   The latest version of the software is selected by default. See Compatibility with ArcGIS Enterprise to confirm which versions are compatible with your deployment.

4. Change the version number, if necessary, and click View Downloads.
5. On the Download dialog box, review the information for the version and language. Change the download language, if necessary.
6. On the Download Components tab, under the Product Components menu, locate ArcGIS Insights (Windows).
7. Click Download.

   The installation package is downloaded and saved to your browser's default folder (for example, Downloads).

To view the help documentation in a supported language other than English, you need to download and install the language pack.

You are now ready to run the installation program.

Run the installation program

Note:

SharePoint, OneDrive, and Jupyter Kernel Gateway connections are enabled by default. You can disable these connections for your organization during the installation process.

You are enrolled in the Esri User Experience Improvement Program by default when you install Insights. You can opt out of the program during the installation.

For more information, see How does the Esri User Experience Improvement Program work for ArcGIS Insights.

Complete the following steps to run the installation program on Windows:

1. Browse to the location of the downloaded installation file, and double-click the setup.exe file.
2. During the installation, read the license agreement and accept it, or close it if you do not agree with the terms.
3. Optional: On the Security Settings dialog, uncheck the boxes to disable SharePoint, OneDrive, and Jupyter Kernel Gateway connections if it's necessary to disable these connections for your organization.
4. Optional: In the Ready to Install the Program dialog, uncheck Click here to participate in the Esri User Experience Improvement Program. (Recommended) to opt-out of the Esri User Experience Improvement Program. Enrollment in the program is recommended to help improve the user experience.
5. Click Install.
   The installation program detects the ArcGIS Enterprise component on your machine—Portal for ArcGIS, ArcGIS Server, or both—and installs the appropriate features.

   Note:

   Portal for ArcGIS and ArcGIS Server will restart automatically as part of the installation process.

If you're working in a distributed environment, repeat the installation until the client is installed on your portal machine (or two machines in a high-availability deployment), and the server component (containing Insights services) is installed on each ArcGIS Server machine in your ArcGIS Server site.

Note:

It is important to run the installation steps on both the portal and server machines when using a distributed environment. If the installations are not run on all machines, Insights will not be installed properly.

The default installation directories are the following:

• C:\Program Files\ArcGIS\Portal\apps for the portal client application
• C:\Program Files\ArcGIS\Server for the server component

Uninstall Insights in ArcGIS Enterprise

Complete the following steps to uninstall Insights from Windows:

1. Open Control Panel and click Programs and Features.
2. From the Programs list, choose the Insights in ArcGIS Enterprise version you have installed on your machine.
3. Select Uninstall/Change to uninstall Insights in ArcGIS Enterprise.

   Note:

   Portal for ArcGIS and ArcGIS Server will restart automatically as part of the uninstall process.

4. If you are working in a distributed environment, repeat the uninstallation steps on all Portal for ArcGIS and ArcGIS Server machines.

Linux

Use the following sections to download, install, and uninstall on Linux:

• Download the installation package
• Run the installation program
• Uninstall Insights in ArcGIS Enterprise

Download the installation package

The installation package contains the following key files:

• Insights-<version-number>.portal.tgz—The Insights web client for your portal
• Insights-<version-number>.server.tgz—The required Insights services for your ArcGIS Server site
• Insights-Setup.sh—The shell script that runs a silent installation of the web client and services listed above

1. Sign in to the My Esri site with your Esri account that is associated with your customer number.
2. Go to My Organization and click Downloads.

   All the software downloads that are available to you (based on your customer number) are displayed.

3. Locate ArcGIS Insights among the products.

   The latest version of the software is selected by default. See Compatibility with ArcGIS Enterprise to confirm which versions are compatible with your deployment.

4. Change the version number, if necessary, and click View Downloads.
5. On the Download dialog box, review the information for the version and language. Change the download language, if necessary.
6. On the Download Components tab, under the Product Components menu, locate ArcGIS Insights (Linux).
7. Click Download.

   The installation package is downloaded and saved to your browser's default folder (for example, Downloads).

To view the help documentation in a supported language other than English, you need to download and install the language pack.

You are now ready to run the installation program.

Run the installation program

Note:

SharePoint, OneDrive, and Jupyter Kernel Gateway connections are enabled by default. You can disable these connections for your organization during the installation process.

You are enrolled in the Esri User Experience Improvement Program by default when you install Insights. You can opt out of the program during the installation or by updating the settings file after the installation is complete.

For more information, see How does the Esri User Experience Improvement Program work for ArcGIS Insights.

Complete the following steps to run the installation program on Linux:

1. Sign in to your machine as a user with administrative privileges.

   Note:

   Installing Insights as a root user is not supported.

2. Use the syntax ./Insights-Setup.sh to run the default installation. You can also append the following syntax options to customize your installation:
   • ./Insights-Setup.sh -h — View the options available in the installation. This command will not run the installation program.
   • ./Insights-Setup.sh -e no (short format) or ./Insights-Setup.sh --esri-user-experience-improvement no (long format) — Opt out of the Esri User Experience Improvement Program. Enrollment in the program is recommended to help improve the user experience.
   • ./Insights-Setup.sh --SharePoint no — Disable Microsoft SharePoint connections, if it's necessary for your organization.
   • ./Insights-Setup.sh --OneDrive no — Disable Microsoft OneDrive connections, if it's necessary for your organization.
   • ./Insights-Setup.sh --KernelGateway no — Disable Jupyter Kernel Gateway connections, if it's necessary for your organization.

   You can append multiple settings to the default installation. For example, to opt out of the Esri User Experience Improvement Program and disable SharePoint connections, use the following syntax: ./Insights-Setup.sh -e no --SharePoint no

   Note:

   Portal for ArcGIS and ArcGIS Server will restart automatically as part of the installation process.

If you're working in a distributed environment, repeat the installation until the client is installed on your portal machine (or two machines in a high-availability deployment), and the server component (containing Insights services) is installed on each ArcGIS Server machine in your ArcGIS Server site.

Note:

It is important to run the installation steps on both the portal and server machines when using a distributed environment. If the installations are not run on all machines, Insights will not be installed properly.

Uninstall Insights in ArcGIS Enterprise

To uninstall Insights, run the following scripts from the command line:

$ ./{HOME}/arcgis/portal/uninstall_Insights.sh
$ ./{HOME}/arcgis/server/uninstall_Insights.sh

If you are working in a distributed environment, run the uninstallation scripts on all Portal for ArcGIS and ArcGIS Server machines.

When Insights has been successfully uninstalled, you are asked to restart Portal for ArcGIS by running the following script: $ ./{HOME}/arcgis/portal/startportal.sh

Upgrade Insights in ArcGIS Enterprise

If you have an earlier version of Insights in ArcGIS Enterprise installed and want to upgrade to the current version, you are not required to uninstall the previous version. Running the ArcGIS Insights installer upgrades the software to the current version. See the detailed steps for more information on installing Insights on Windows and Linux.

If you are upgrading both ArcGIS Enterprise and Insights, it is best practice to complete the ArcGIS Enterprise upgrade first, including the postupgrade steps, before upgrading Insights. For more information, see Upgrade a base deployment with ArcGIS Enterprise Builder or Upgrade your ArcGIS Enterprise portal.

For more information on which Insights versions are supported by your ArcGIS Enterprise deployment, see Compatibility with ArcGIS Enterprise. You may also want to verify the supported database versions.

Upgrade ArcGIS Enterprise 10.7 or earlier

Note:

The following steps are not required to upgrade Insights in ArcGIS Enterprise 2020.2 or higher to Insights in ArcGIS Enterprise 2021.1 or higher. You can upgrade ArcGIS Enterprise 10.7.1 and higher without uninstalling Insights in ArcGIS Enterprise first. Check Compatibility with ArcGIS Enterprise to determine if Insights in ArcGIS Enterprise must also be upgraded.

If you are upgrading ArcGIS Enterprise 10.7 or earlier, you are required to uninstall Insights before completing the upgrade. Complete the following steps to upgrade both Insights and ArcGIS Enterprise:

1. Upgrading ArcGIS Enterprise may require upgrading Insights to a compatible version. Check the compatibility between Insights and ArcGIS Enterprise. You may also want to verify the supported database versions.
2. Uninstall Insights in ArcGIS Enterprise from your Windows or Linux machine.
3. Upgrade ArcGIS Enterprise to the new version, including the postupgrade steps. For more information, see Upgrade a base deployment with ArcGIS Enterprise Builder or Upgrade your ArcGIS Enterprise portal.
4. Install Insights in ArcGIS Enterprise on your Windows or Linux machine (either the same version or the new version).

Note:

If you are upgrading to ArcGIS Enterprise 10.7 or later from 10.6.1 or earlier, members of your organization may be automatically updated to a compatible user type, or your organization may be licensed for more than one user type for each level. If your organization is licensed for more than one user type, the administrator of the organization must apply the correct user types to each member before they can access Insights. Insights users can have the Creator, GIS Professional, or Insights Analyst user type. For more information, see Upgrade your ArcGIS Enterprise portal.

Uninstalling Insights in ArcGIS Enterprise does not affect your saved Insights items, such as workbooks, pages, and database connections.

Allow OS authentication for database connections

Note:

These additional steps are required if you are updating Insights from version 2020.1 or earlier to version 2020.2 or later.

To create database connections using OS authentication if you have an existing Insights in ArcGIS Enterprise installation, complete the following steps after upgrading Insights:

1. Remove the existing SQL Server connector.
2. Restart ArcGIS Server.
3. Add the SQL Server connector.
4. Restart ArcGIS Server.

Once Insights is upgraded and SQL Server is re-registered, the domain administrator must enable OS authentication.

Next steps

After Insights in ArcGIS Enterprise is installed, the next step is to assign the required user types, privileges, and licences to Insights users in your organization. For more information, see Administer Insights in ArcGIS Enterprise and Insights in ArcGIS Online.