The Portal for ArcGIS 10.8.1 setup is designed to detect and upgrade an existing installation of Portal for ArcGIS.
Prepare to upgrade Portal for ArcGIS
Before upgrading, carefully review the following information:
- If you are upgrading to 10.8.1, you may need to reauthorize
your software for 10.8.1. If you are upgrading from a version within the same release series—for example, from 10.8 to 10.8.1—you do not need to obtain a new license file. If you are upgrading from a version from an earlier release series, you must obtain a new portal license file from My Esri.
The license file you input during the upgrade is used to license your portal's users and apps. Ensure the new license file is adequate for your current user and app configuration.
- Upgrades are not supported from Portal for ArcGIS 10.2.2 or earlier versions to 10.8.1. To upgrade to 10.8.1, you must first upgrade it to 10.3 or a later version, then upgrade again to 10.8.1.
- If you are at version 10.3 or later, running the Portal for ArcGIS 10.8.1 setup automatically upgrades your portal to 10.8.1. There is no need to obtain and install each previously released version in sequence or to uninstall your previous version of Portal for ArcGIS.
- When upgrading from a Portal for ArcGIS version prior to 10.7 to version 10.7 or later, automatic account creation is disabled. To allow new users to create their own built-in accounts, you must set a default user type and role for new members and enable automatic account creation. These settings will be maintained in future upgrades.
- If you configured a highly available portal, there are specific steps you need to follow to complete the upgrade. These steps are outlined in the topic Configure a highly available portal.
Starting at 10.6, highly available deployments use available ports 5701, 7005, 7099, 7654, 7120, and 7220 for intermachine communications. You must ensure that your firewall allows local communication on these ports and that they are not currently in use by another application.
- Starting at 10.8.1, the administrative contacts list is used to send automatic email notifications if email settings are configured for your organization. If no administrative contacts are set, the oldest administrator account in the organization or the Initial Administrator Account will receive the email notification.
- If you are upgrading from 10.8 to 10.8.1 or later, and you have an information banner configured, you must enable the banner through your advanced site settings to have your information banner display on sites created with ArcGIS Enterprise Sites. After upgrading from 10.8 and enabling this setting, it will be retained for future upgrades.
- If you configured an enterprise geodatabase as the managed database for your hosting server and you are upgrading from Portal for ArcGIS 10.6 or an earlier release to 10.8.1, you must conduct a few additional steps. Once you upgrade ArcGIS Server, you need to register the enterprise geodatabase as a database (as opposed to a managed database). Next, install ArcGIS Data Store and register it as a relational data store. This configures ArcGIS Data Store as your hosting server's managed database.
- The time it takes to complete the upgrade varies, depending on how much content your portal contains and how many accounts are registered, as well as how many components and customizations you deploy.
- If you published applications based on ArcGIS Configurable Apps templates, check to see if the app template was retired. Retired configurable app templates may not function or display correctly once you upgrade your portal. You will need to re-create these apps using new app templates. Note that if your portal is several releases old, you need to check the retired templates for each release. For example, if you're upgrading from Portal for ArcGIS 10.5, check the list of retired templates for all releases between 10.5 and the current release.
- If you have Esri apps configured with your portal, ensure you are at a version that's compatible with the 10.8.1 portal after upgrading.
- If you configured ArcGIS Insights, you must uninstall ArcGIS Insights prior to upgrading ArcGIS Enterprise. After the upgrade is complete, you need to install a compatible version of ArcGIS Insights.
- If you configured ArcGIS Navigator mobile map packages with your portal, you need to reconfigure them after upgrading the portal to 10.8.1.
- If you use ArcGIS Living Atlas of the World content in maps or apps, confirm that the items you use are not in a mature support or deprecated status before you upgrade. At each release, some Living Atlas content is retired and no longer available. If you are using one of these items, it will no longer function once you upgrade. For a list of the Living Atlas content retired at this release, see Living Atlas content life cycles and updates.
- If your ArcGIS Server license has an expiration date, update the license in your relational ArcGIS Data Store after upgrading and updating your ArcGIS Server license and upgrading the relational data store.
- If your portal is currently in read-only mode, turn the mode off before running the upgrade.
The Portal for ArcGIS setup asks for the account the Windows service will run as. When upgrading from versions 10.4 and later, you can upgrade existing content on a shared network directory provided the account running the Windows service has full access to these locations.
If the Windows service is currently running as a LocalSystem account with no password applied, you must first change the account to a local account with a password before proceeding with the upgrade.
ArcGIS Enterprise upgrade order
For your ArcGIS Enterprise portal to function, it must be the same version as your hosting server, ArcGIS Web Adaptor, and ArcGIS Data Store. The recommended order to upgrade your ArcGIS Enterprise deployment is as follows:
- Upgrade Portal for ArcGIS
- Upgrade ArcGIS Web Adaptor (for Portal) for IIS or Java (Windows)
- Upgrade the ArcGIS Server site serving as the portal's hosting server
- Upgrade ArcGIS Web Adaptor (for Server) for IIS or Java (Windows)
- ArcGIS Data Store
- Upgrade ArcGIS Server (any additional sites in the deployment)
- Your ArcGIS Enterprise portal's version must match the version of the hosting server, any GeoAnalytics Server, any GeoEvent Server, and any Raster Analytics Server federated with it. However, a 10.8.1 portal will work with any other federated server that is at version 10.5 or later. For example, a 10.5 GIS Server (that is not the hosting server) and a 10.5.1 Business Analyst Server can be federated with a 10.8.1 portal, as long as its hosting server is at version 10.8.1.
- If you have registered items in your portal from a nonfederated ArcGIS Server site, you do not need to upgrade this ArcGIS Server site to 10.8.1 to use the site's services with your portal. Services from previous versions of ArcGIS Server can be consumed by Portal for ArcGIS 10.8.1.
- If the ArcGIS Server site you've federated with the portal includes multiple machines, upgrade your GIS servers sequentially. If you have ArcGIS Web Adaptor (single or multiple) configured with your ArcGIS Server site, you also need to update the Web Adaptors to the same version as ArcGIS Server.
- If you cannot update your current Web Adaptor, you can alternatively install a 10.8.1 version of ArcGIS Web Adaptor (IIS) alongside your previous version on the same machine. For example, you can retain your 10.5 version of ArcGIS Web Adaptor (IIS) and install 10.8.1 on the same web server. You must keep the same Web Adaptor context when upgrading. To do this, uninstall the Web Adaptor currently configured with your portal, and then install the 10.8.1 Web Adaptor with the same name used previously. Note that two Web Adaptors with the same context cannot be installed on the same machine.
Back up your content
Create a full backup of each type of ArcGIS Data Store configured with your portal's hosting server before upgrading.
You also need to back up any customization you configured for your portal (such as properties you modified in config.js).
Previously, you were required to back up the certificate keystore (portal.ks) containing certificates you imported into the portal. Starting at 10.4.1, this is no longer necessary and the portal keystore is automatically migrated during upgrade.
- If you heavily customized the previous version of your portal, it is recommended that you install 10.8.1 on a separate machine and prototype your portal upgrade.
- You must also back up extensions for ArcGIS Dashboards or ArcGIS Web AppBuilder. The upgrade will not preserve any extensions you have deployed for these clients. Once your upgrade is complete, you must redeploy your extensions.
- Conversely, your content, services, site information, and security settings are all automatically backed up and preserved when upgrading. General settings you edited through the portal website, such as adding your organization's logo and name to the website, are also preserved when upgrading. You don't need to manually back up this information before upgrading.
- To ensure you have enough disk space to support the automatic backup created during the upgrade, determine the amount of space allocated to the portal's content, index, db, and temp directories. Validate that the amount of free space available on disk is at least 2.5 times this amount. If not, allocate at least 2.5 times more space on disk. The portal upgrade needs this free space to successfully back up and upgrade your portal's content, site information, and security settings. The default location for these directories is C:\arcgisportal.
- If you have customized the SSL protocols or the cipher suites used by the portal, record this information, as it is not retained during the upgrade process. Once the portal upgrade completes, update the SSLCertificates page within the portal's Administrator Directory to restore the previous SSL certificate configuration settings.
- When the upgrade completes, the backed-up information is retained on disk. For example, you'll see this information denoted with _10.<version number> appended to the end of the directory. It's recommended you move this information to another location to save disk space.
- It is also recommended that you back up the arcgisportal content directory folder. If your upgrade encounters issues and you then need to revert to your previously installed version, you can apply this folder to restore your portal's content.
Perform an upgrade of your portal deployment
Your portal deployment, any ArcGIS Server site you federated with your portal, ArcGIS Data Store, and ArcGIS Pro (if licensed through the portal), will be offline during the upgrade.
- Back up the following information:
Tip:You can follow steps below to back up your site, or you can use the webgisdr utility to create a back up of your ArcGIS Enterprise deployment. To do so, follow steps to export ArcGIS Enterprise.
- Any customization you configured for your portal, such as properties you modified in config.js. If you heavily customized the previous version of your portal, it is recommended that you install 10.8.1 on a separate machine and prototype your portal upgrade.
- All data stores deployed through ArcGIS Data Store. See Upgrade ArcGIS Data Store for details on running the backup.
- Any extensions you have deployed for Dashboards or Web AppBuilder. These are not preserved upon upgrading and must be redeployed after the upgrade is complete.
- Back up your ArcGIS Server site so that when you need to revert your site to the earlier version, you can import and restore the site.
- Determine the amount of disk space allocated to the portal's content, index, db, and temp directories. Validate that the amount of free space available on disk is at least 2.5 times this amount. If not, allocate at least 2.5 times more space on disk. The portal upgrade needs this free space to successfully back up and upgrade your portal's content, site information, and security settings. The default location for these directories is C:\arcgisportal. If the content directory resides on a different machine, the same recommendation applies.
When the upgrade completes, the backed-up information is retained on disk. For example, a new folder called upgrade-backup is created and contains version specific folders with backed up contents. It's recommended you move this information to another location to save disk space.
- Log in to the machine hosting the ArcGIS Web Adaptor you're using with your portal, and uninstall ArcGIS Web Adaptor. For full instructions, see the uninstallation topic for IIS or Java (Windows). Be sure to note the context of the Web Adaptor before you uninstall it.
- Start the Portal for ArcGIS setup program, Setup.exe, and read the welcome screen and terms. Click Next when you're ready to proceed. You can also upgrade Portal for ArcGIS silently by using the following command line parameter:
<path to Portal for ArcGIS setup download>\setup.exe /qb USER_NAME=admin PASSWORD=itsasecret
- Read the license agreement and accept it, or exit if you do not agree with the terms. The features that will be installed display.
- Click Install to begin the upgrade. Do not interrupt the installation process.
- Click Finish to close the installation wizard. The portal website opens in a browser window.
- Clear your browser's cache (including cookies). Information left over in the cache from the previous version of the website may cause the upgraded website to display incorrectly, and you may not be able to sign in. It's recommended that you clear the cache (including cookies) on all browsers that will view the upgraded portal website.
- On the Import License File page, browse to your portal license file (.json). This file is obtained from My Esri and contains your portal's user and app license information. Click Continue Portal Upgrade. This triggers the upgrade and creates a backup of your portal's content, site information, and security settings. This step will take a few minutes to complete.
The license file you input during the upgrade is used to license your portal's users and apps. Ensure the new license file is adequate for your current user and app configuration.
If you are upgrading within the same release version, you will not be prompted to import a new license file. You can import a new license file at any time once the upgrade is complete.
- Install the Web Adaptor that will be used with your portal. For full instructions, see the installation topic for IIS or Java (Windows). Ensure that you use the Web Adaptor context that you used in the previous version.
- Configure ArcGIS Web Adaptor with your portal. For full instructions, see the configuring topic for IIS or Java (Windows).
- Verify that you can sign in to the portal website through the ArcGIS Web Adaptor URL as an administrator of your organization. The URL is formatted https://webadaptorhost.domain.com/webadaptorname/home.
- If you receive a notice that post-upgrade steps are required, you must click OK on the message dialog box to complete the required post-upgrade steps. These include upgrading ArcGIS Living Atlas of the World content, re-indexing content, and updating the association between portal machines in a highly available portal.
- If you receive a notice regarding licenses when you sign in to the portal after an upgrade, you may not have imported a license file that meets your current licensing configuration, or your users may be assigned a temporary user type. See Considerations after upgrading Portal for ArcGIS for more details.
- If you federated an ArcGIS Server site with your portal and you're using ArcGIS Web Adaptor with your site, log in to the machine hosting the Web Adaptor and uninstall Web Adaptor. Take note of the Web Adaptor name; you need to use the same name when you reinstall. For full instructions, see the uninstallation topic for IIS or Java (Windows).
- If you federated an ArcGIS Server site with your portal, upgrade each site to 10.8.1. There is no need to uninstall and reinstall. You need to run the setup on each ArcGIS Server machine in each site. Upgrade your ArcGIS Server sites sequentially (back-to-back). For full instructions, see Upgrading a previous version of ArcGIS Server.
- When the server upgrade completes, verify you can access the local URL of the ArcGIS Server Services Directory. The local URL is formatted https://gisserver.domain.com:6443/arcgis/rest/services.
- If you were previously using ArcGIS Web Adaptor with ArcGIS Server, reinstall ArcGIS Web Adaptor. Use the same name you specified for Web Adaptor in the previous installation. For full instructions, see the installation topic for IIS or Java (Windows)
- Configure ArcGIS Web Adaptor with your server. For full instructions, see the configuring topic for IIS or Java (Windows). If you had previously enabled administrative access to your ArcGIS Server through Web Adaptor, ensure that you enable it again. This is especially important if you used the Web Adaptor URL for the administrative URL when federating your portal and ArcGIS Server site.
- Verify that you can access the ArcGIS Server Services Directory through the ArcGIS Web Adaptor URL. The URL is formatted https://webadaptorhost.domain.com/webadaptorname/rest/services.
- If your portal's hosting server is using ArcGIS Data Store, create a backup of the data store, upgrade ArcGIS Data Store, and reconfigure the data store to work with ArcGIS Server. See Upgrade ArcGIS Data Store for specific instructions.
- If you configured ArcGIS Pro or Drone2Map licenses with your organization, optionally upgrade ArcGIS License Server Administrator. When upgrading ArcGIS License Server Administrator, members with ArcGIS Pro licenses will be unable to access ArcGIS Pro. If members are currently logged in to ArcGIS Pro, they will see a message stating that the program will be closed in twenty-four hours. Members can complete or save their work within this time period. You must import the same license file (.json) that you imported into your portal into the ArcGIS License Server Administrator.
- Restore any customization you previously configured for your portal. When restoring your portal customizations in 10.8.1, do not replace the files you modified in the previous version in 10.8.1. This adversely affects your 10.8.1 deployment. You must open each file at 10.8.1 and manually re-add your custom behavior from the previous version.
Esri recommends using the portalScan.py script to check for security best practices with your upgraded ArcGIS Enterprise portal.
- You must additionally install the Web Styles setup if you want to use a complete set of 3D symbology from Scene Viewer. For additional information, see Scene Viewer requirements.
Note:Starting at 10.6, you can also use the upgradeportal command line utility to complete the upgrade and post-upgrade operations silently. In the command line, navigate to your <Portal install directory>/tools/upgradeportal folder and run the following: upgradeportal.bat -lf <path to portal json file> -s. For assistance, run the command with -h or --help.
Considerations after upgrading Portal for ArcGIS
After upgrading, carefully review the following information.
- After upgrading, the portal website does not display correctly or I can't log in. What's wrong?
- After upgrading, I don't see all of my items, groups, and users in my portal. What's going on?
- After upgrading to 10.8.1, Living Atlas content is no longer accessible in my portal.
- After upgrading to ArcGIS Enterprise 10.8.1, which user type will my members be assigned?
- After upgrading, automatic account creation is failing with a software authorization error.
- When I log into portal, I receive a notice stating that "the number of licenses assigned exceeds the number of licenses available. Members assigned these licenses may not be able to access the portal. Go to the Licenses tab for more details". How do I resolve this issue?
- There was an error creating my initial administrator account. How do I resolve this to complete the upgrade?
- Do I need to do anything with my utility services after upgrading?
- My portal is configured with ArcGIS World Geocoding Service. Do I need to reconfigure after upgrading?
After upgrading, the portal website does not display correctly or I can't sign in. What's wrong?
Clear your browser's cache (including cookies). These errors are typically due to leftover information from the previous version of the website being cached in the browser. If you still can't sign in, make sure you are using the initial administrator account or an account that has administrative privileges to your portal. If the cards on the Organization Overview tab are not loading, import your portal license file (.json). You can import the license file through the Portal Administrator API using the URL https://portal.domain.com:7443/arcgis/portaladmin/license/importLicense. Ensure that this is the correct license file for your portal. When importing a new license file, any user types or app licenses in your portal are overwritten by the new license file.
After upgrading, I don't see all of my items, groups, and users in my portal. What's going on?
After installing the software and specifying the initial administrator account, a reindex of your portal is initialized. Initially, you may not see all of your items, groups, and users because the reindex is not complete. Depending on the number of users and volume of content in your portal, it will take some time for the reindex to complete. For example, a small organization (hundreds of users and content items) running Portal for ArcGIS on a machine with 8 cores may take 15 minutes to reindex. Conversely, a large organization (tens of thousands of users and content items) running Portal for ArcGIS on a machine with 8 cores may take over 3 hours to reindex.
You can check the status of the reindex by following the steps below. When the store and index counts are equal, the reindex and upgrade are complete.
- Open the ArcGIS Portal Directory and sign in with the initial administrator account. The URL is formatted https://portal.domain.com:7443/arcgis/portaladmin.
- Click System > Indexer > Index Status.
- Refresh the page to obtain the latest status.
After upgrading to 10.8.1, Living Atlas content is no longer accessible in my portal.
If a Living Atlas layer is not accessible in your portal after you upgrade, it's possible that the item is retired at this release. Check Living Atlas content life cycles and updates for an updated list of retired items.
If subscriber or premium content items cannot be opened post-upgrade, verify that the ArcGIS Online account you used when you configured the portal to access this content is still valid. If it is not, you must complete additional steps to update this account and the Living Atlas content.
After upgrading to ArcGIS Enterprise 10.8.1, which user type will my members be assigned?
If you are upgrading from a version between 10.2.x and 10.4.x, and are licensed for one compatible user type, all members are assigned that user type.
If you are upgrading from a version between 10.5.x and 10.6.x, your level 1 and level 2 members will be assigned a compatible user type, if you are licensed for only one compatible user type for each level.
In the event that you license more than one compatible user type in an upgrade, members will be assigned a temporary user type. In this scenario, your named users or level 2 members are assigned the Standard (Temporary) user type and your level 1 members are assigned the Lite (Temporary) user type. Your portal members assigned these user types will not be able to access the portal. Following the upgrade, an administrator must update the user type for all members to a valid licensed user type.
After upgrading, automatic account creation is failing with a software authorization error.
If you are upgrading from a version prior to 10.7 to version 10.7 or later, automatic account creation is disabled. After completing the upgrade, you need to assign a default user type and role for new members and then enable automatic account creation in the ArcGIS Portal Administrator Directory. Starting at 10.8, the default user type and role for new members can be set in the organization settings in the portal or using the setUserDefaultSettings operation in the portal self resource in the ArcGIS Portal Directory sharing API.
When I log into portal, I receive a notice stating that "the number of licenses assigned exceeds the number of licenses available. Members assigned these licenses may not be able to access the portal. Go to the Licenses tab for more details". How do I resolve this issue?
This notice displays for administrators when they sign in to the portal and the portal's licensing is in overdraft. The number of users assigned a user type or add on license exceeds the number of licenses available.
The administrator can navigate to the Licenses tab to view the licenses in overdraft. Licenses in overdraft have a greater number assigned than the number available. Depending on your organization's needs, you can reassign licenses or obtain a new portal license file with the correct allocation of licenses.
If your users are assigned the Standard (Temporary) or Lite (Temporary) user type, you need to update the user type for all members to a valid licensed user type. See After upgrading to ArcGIS Enterprise 10.8.1, which user type will my members be assigned? for more details.
There was an error creating my initial administrator account. How do I resolve this to complete the upgrade?
If you receive this error when creating the initial administrator account, information in the portal logs can help you resolve the issue. Often, this error may occur if network connectivity was temporarily lost when creating the account. To access the logs, browse to the logs directory and open the most recent log file (for example, C:\arcgisportal\logs\<machine name>\portal\portal-20141201.095803-8596-0.0.log). If necessary, you can share this information with Esri Support.
If you were upgrading from 10.3.1 and had ArcGIS Survey123 or ArcGIS Collector configured with your portal, contact Esri Support to continue the upgrade.
If you are reverting to your previous deployment, before you revert to the earlier version, copy all log files to aid in troubleshooting your support incident. (To access the logs, browse to the logs directory (for example, C:\arcgisportal\logs\).
Do I need to do anything with my utility services after upgrading?
If you use the OfflinePackaging, RasterUtilities, or GeocodingTools utility services, you need to manually update them after you upgrade:
- Once your upgrade is complete, log in to ArcGIS Server Manager as the user who owns the utility services.
- On the Manage Services section of the Services tab, click the Utilities folder.
- Click the Sharing Properties icon.
- On the dialog box that appears, click Save. This updates the service in your ArcGIS Enterprise portal.
- Sign in to the portal as an administrator. On the Content tab, locate the service you've updated. Click Share. Update the sharing settings if needed, then click OK. This updates the service with each group it's shared to.
- Repeat these steps for each applicable service.
My portal is configured with ArcGIS World Geocoding Service. Do I need to reconfigure after upgrading?
If you upgraded from version 10.2.x, you need to re-create the proxy item in your portal to ArcGIS World Geocoding Service. Then, configure the item as a geocoder for the portal. As of 10.3.1, you do not need to update the proxy item to ArcGIS World Geocoding Service.