The Portal for ArcGIS 10.4.1 setup is designed to detect and upgrade an existing installation of Portal for ArcGIS.
Considerations before upgrading Portal for ArcGIS
Before upgrading, carefully review the following information.
- Can I upgrade directly to Portal for ArcGIS 10.4.1?
- Do I need to uninstall my previous version of Portal for ArcGIS before installing Portal for ArcGIS 10.4.1?
- What is the order for upgrading my Portal for ArcGIS deployment to 10.4.1?
- Do I need to reauthorize when upgrading to 10.4.1?
- How long does the upgrade take to complete?
- Do I need to back up any information before performing the upgrade?
- Do the ArcGIS Web Adaptor and Portal for ArcGIS product versions need to be in sync?
- If I've federated ArcGIS Server with my portal, do I need to upgrade ArcGIS Server when I upgrade the portal?
- If I've federated ArcGIS Server with my portal, should I unfederate before upgrading?
- If I have a hosting server that uses ArcGIS Data Store, do I need to upgrade the data store when I upgrade the portal?
- If I've configured ArcGIS Pro licenses with my organization, do I need to upgrade ArcGIS Pro or ArcGIS License Server Administrator when I upgrade the portal?
- I've configured a highly available portal, how do I upgrade my configuration?
- What else do I need to consider before upgrading my portal?
Can I upgrade directly to Portal for ArcGIS 10.4.1?
Yes. For example, if you have version 10.2.1 installed, running the 10.4.1 setup will automatically upgrade it 10.4.1. There is no need for you to obtain and install each released version in order to upgrade to 10.4.1.
Do I need to uninstall my previous version of Portal for ArcGIS before installing Portal for ArcGIS 10.4.1?
No, but you can. If you have an earlier version of Portal for ArcGIS installed, the setup will automatically begin the upgrade to 10.4.1. When the installation has finished running, you'll create the initial administrator account to complete the upgrade. If you uninstall the earlier version and then install 10.4.1, the same behavior applies.
What is the order for upgrading my Portal for ArcGIS deployment to 10.4.1?
There is no particular order you must follow to upgrade your deployment to 10.4.1 unless your deployment includes ArcGIS Data Store. In that case, ArcGIS Server must be upgraded before you upgrade the data store.
An important point to consider is that your portal will be offline during the upgrade. If your deployment includes a federated ArcGIS Server site, your portal and federated site will be offline during the upgrade.
If you have registered items in your portal from a non-federated ArcGIS Server site, you do not need to upgrade the server to 10.4.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.4.1.
Do I need to reauthorize when upgrading to 10.4.1?
No. Your previous authorization will be preserved and reconfigured for use in 10.4.1.
How long does the upgrade take to complete?
The time it takes to complete the upgrade varies depending on how much content your portal contains and how many accounts are registered. For example, a small organization (hundreds of users and content items) running Portal for ArcGIS on a machine with 8 cores may take 50 minutes to upgrade. 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 upgrade.
The time it takes to complete also depends on how many components and customizations you deployed. For example, if you configured ArcGIS Pro licenses with your organization, have multiple federated ArcGIS Server sites and ArcGIS Data Store, or if your portal is highly customized, it will take longer to upgrade than if you deployed Portal for ArcGIS and one federated ArcGIS Server.
Do I need to back up any information before performing the upgrade?
If you are using ArcGIS Data Store with your portal's hosting server, create a full backup of the data store before upgrading.
You'll also need to back up any customization you've configured for your portal (such as properties you modified in config.js).
Legacy:
Previously, you were required to back up the certificate keystore (portal.ks) containing certificates you'd imported into the portal. Starting at 10.4.1, this is no longer necessary and the portal keystore will be automatically migrated during your upgrade.
If you heavily customized the previous version of your portal, it is recommended that you install 10.4.1 on a separate machine and prototype your portal upgrade.
Extensions for Operations Dashboard or Web AppBuilder must also be backed up. 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 during upgrading, 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 will need 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 <Portal for ArcGIS installation directory>/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, 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.
Do the ArcGIS Web Adaptor and Portal for ArcGIS product versions need to be in sync?
Yes. You cannot configure an earlier version of ArcGIS Web Adaptor to work with Portal for ArcGIS 10.4.1. The Web Adaptor version must always match the installed version of Portal for ArcGIS.
If you cannot update your current Web Adaptor, you can alternatively install a 10.4.1 version of ArcGIS Web Adaptor alongside your previous version on the same machine. For example, you can retain your 10.1 SP1 version of ArcGIS Web Adaptor and install 10.4.1 on the same web server.
For full instructions, see the following topics:
If I've federated ArcGIS Server with my portal, do I need to upgrade ArcGIS Server when I upgrade the portal?
Yes. For your portal deployment to function correctly, your portal and ArcGIS Server versions need to be the same. 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 I've federated ArcGIS Server with my portal, should I unfederate before upgrading?
No. It's strongly recommended that you do not unfederate when you upgrade your portal deployment. Doing this will adversely impact your portal deployment. For example, when you unfederate, all hosted service items remain in the portal but they are disconnected from their services in ArcGIS Server. This means that members will not be able to access, share, or use these services in the portal. Additionally, any existing ArcGIS Server services that were imported during the federation process are removed from the portal and are no longer available.
If I have a hosting server that uses ArcGIS Data Store, do I need to upgrade the data store when I upgrade the portal?
Yes. Your portal, ArcGIS Server, and ArcGIS Data Store versions need to be the same. During the upgrade process, always upgrade ArcGIS Server before you upgrade the ArcGIS Data Store with which it is configured.
As mentioned above, 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 I've configured ArcGIS Pro licenses with my organization, do I need to upgrade ArcGIS Pro or ArcGIS License Server Administrator when I upgrade the portal?
No. Earlier versions of ArcGIS Pro and ArcGIS License Server Administrator are compatible with 10.4.1. However, it's highly recommended you upgrade ArcGIS Pro and ArcGIS License Server Administrator to take advantage of new functionality and bug fixes.
Note:
Starting at ArcGIS Pro 1.2, ArcGIS License Server Administrator must be at version 10.4 or later. If you upgrade to ArcGIS Pro 1.2, you must also upgrade your ArcGIS License Server Administrator to at least version 10.4.
When upgrading Portal for ArcGIS or ArcGIS License Server Administrator, members with ArcGIS Pro licenses will be unable to access ArcGIS Pro during each upgrade. 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 because ArcGIS Pro cannot connect to the licensing portal. Members can complete or save their work within this time period.
I've configured a highly available portal, how do I upgrade my configuration?
If you've configured a highly available portal, there are very specific steps you'll need to follow to complete the upgrade. These steps are outlined in the topic Configuring a highly available portal. Once you've upgraded your portal configuration, proceed with upgrading the remaining ArcGIS components in your organization as outlined below.
What else do I need to consider before upgrading my portal?
- If you moved the portal's content directory to a shared network directory, you'll need to perform some additional steps when upgrading. The upgrade steps below include full instructions for configuring the upgraded portal to use the existing content directory.
- If you moved the portal's index, db, or temp directories to a shared network directory, you'll need to move them back to a local directory before performing the upgrade. Portal for ArcGIS does not support these directories being placed on a network share; they must be local to the portal machine. The upgrade steps below include full instructions for moving these directories back to local directories.
- If you published applications based on configurable app 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.2, check the list of retired templates for all releases between 10.2 and the current release.
Steps to perform an upgrade of your portal deployment
Caution:
Your portal deployment, any ArcGIS Server site you've federated with your portal, ArcGIS Data Store (if used), and ArcGIS Pro (if used), will be offline during the upgrade.
- Back up the following information:
- 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.4.1 on a separate machine and prototype your portal upgrade.
- The ArcGIS Data Store managed database. See Upgrade ArcGIS Data Store for details on running the backup.
- Any extensions you have deployed for Operations Dashboard or Web AppBuilder. These will not be preserved upon upgrading and must be redeployed after the upgrade is complete.
- 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 will need 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 <Portal for ArcGIS installation directory>/arcgisportal. If the content directory resides on a different machine, the same recommendation applies.
Note:
When the upgrade completes, the backed up information is retained on disk. For example, you'll see this information listed 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.
- Log in to the machine hosting the Web Adaptor you're using with your portal, and uninstall ArcGIS Web Adaptor. For full instructions, see the uninstallation topic for IIS, Java (Windows), or Java (Linux).
- From the command prompt, launch the Portal for ArcGIS setup script as the same user that was used to install the existing portal (for example, <CD ROOT or untar directory>/Setup). You do not need to stop Portal for ArcGIS before launching this script.
Tip:
To launch the setup script from the Portal for ArcGIS setup media, click the setup script, and select the Run in Terminal button.
- The setup will detect your existing version of Portal for ArcGIS on the target machine and prompt you to continue or exit the upgrade. See the following example:
========================================================================= Portal for ArcGIS 10.4.1 (Linux) ========================================================================= Your Portal for ArcGIS 10.3 is installed at: /home/ags/arcgis/portal Confirm Settings ========================================================================= Product to upgrade: Portal for ArcGIS 10.3 (Linux) Location to upgrade: /home/ags/arcgis/portal Your Portal for ArcGIS 10.3 will be stopped when performing the upgrade and Portal for ArcGIS 10.4.1 will be started after the upgrade completes. 'y' to continue with these settings 'q' to exit without upgrading this product Enter choice [y,q] (y): - Type y, and press Enter to accept the detected settings and continue with the upgrade. When the portal upgrade completes, 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 log in. It's recommended that you clear the cache (including cookies) on all browsers that will be viewing the upgraded portal website.
- Choose to create a portal.
Tip:
When conducting an upgrade, the process of creating a new portal will create a new version of your existing portal and migrate your content, users, and settings.
Specify the user name, password, email, and identity question and answer of the initial administrator account. The dialog box for the location of the portal's content directory will be greyed out, as you cannot change the content directory location in an upgrade. Click Create. 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.
Note:
The information you enter for the initial administrator account does not have to match the account information you specified in the earlier version of your portal. If you enter new information, this step will create a new account and the existing initial administrator account will be preserved. If you enter the same account information as the earlier version, the existing account will be used as the initial administrator.
- 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 > Reindex.
- Click the Mode drop-down list, and select Full.
- Click Reindex. This step will complete the upgrade of your portal. Depending on the number of users and volume of content in your portal, it will take some time for the reindex to complete. Do not interrupt the reindex process. You can monitor the indexing status by opening a new browser window (or tab), navigating to System > Indexer > Index Status, and refreshing the page. When the store and index counts are equal, the reindex and upgrade is complete.
- Install the Web Adaptor that will be used with your portal. For full instructions, see the installation topic for IIS, Java (Windows), or Java (Linux).
- Configure ArcGIS Web Adaptor with your portal. For full instructions, see the configuring topic for IIS, Java (Windows), or Java (Linux).
- 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://webadaptor.domain.com/arcgis/home.
- If you've 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 the Web Adaptor. Take note of the Web Adaptor name; you'll need to use the same name when you reinstall. For full instructions, see the uninstallation topic for IIS, Java (Windows), or Java (Linux).
- If you've federated an ArcGIS Server site with your portal, upgrade each site to 10.4.1. There is no need to uninstall and reinstall. You'll need to run the setup on each GIS server machine in each site. Upgrade your GIS servers sequentially (back-to-back). For full instructions, see Upgrading a previous version of ArcGIS for 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 the Web Adaptor in the previous installation. For full instructions, see the installation topic for IIS, Java (Windows), or Java (Linux).
- Configure ArcGIS Web Adaptor with your server. For full instructions, see the configuring topic for IIS, Java (Windows), or Java (Linux).
- Verify that you can access the ArcGIS Server Services Directory through the ArcGIS Web Adaptor URL. The URL is formatted https://webadaptor.domain.com/arcgis/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've configured ArcGIS Pro 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 are not required to reconfigure ArcGIS Pro licenses after upgrading ArcGIS License Server Administrator.
- Restore any customization you previously configured for your portal. When restoring your portal customizations in 10.4.1, it's recommended that you do not replace the files you modified in the previous version in 10.4.1. This may adversely affect your 10.4.1 deployment. You need to open each file at 10.4.1 and manually re-add your custom behavior from the previous version.
Considerations after upgrading Portal for ArcGIS
After upgrading, carefully review the following information.
- After upgrading, the portal website does not display correctly, displays an error message, 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?
- When I access the portal website after installing 10.4.1, I see a software authorization error stating that the number of registered members in the portal exceeds the maximum number that the portal has been licensed for. How do I resolve this issue?
- When attempting to create the initial administrator account when upgrading my portal, I receive the message There was an error creating your initial administrator account. How do I resolve this to complete the upgrade?
- I enabled Operations Dashboard through my portal; do I need to update it after upgrading?
After upgrading, the portal website does not display correctly, displays an error message, or I can't log 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 log in, make sure you are using the initial administrator account or an account that has administrative privileges to your portal.
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, you're required to reindex your portal. This step completes the upgrade of your portal. 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 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 is 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.
When I access the portal website after installing 10.4.1, I see a software authorization error stating that the number of registered members in the portal exceeds the maximum number that the portal has been licensed for. How do I resolve this issue?
In Portal for ArcGIS 10.2.1 and later versions, the portal's named user licensing model is enforced. You will no longer be able to add more members into your portal than what it is currently licensed for. If the number of members your portal is licensed for is exceeded at 10.4.1, you will see a software authorization error message when accessing the portal website with an account that has administrative privileges. Additionally, users will not be able to create new accounts and members without administrative privileges will not be able to sign in to the portal. See Enforcement of named user licensing to learn more about how to resolve these issues.
When attempting to create the initial administrator account when upgrading my portal, I receive the message There was an error creating your 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, <Portal for ArcGIS installation directory>/arcgisportal/logs/<machine name>/portal/portal-20141201.095803-8596-0.0.log). If necessary, you can share this information with Esri Support.
I enabled Operations Dashboard through my portal; do I need to update it after upgrading?
Yes. If you previously created an item referencing Operations Dashboard, or if you deployed the app to your portal, you'll need to update the item and redeploy the app after you upgrade your portal. For full instructions, see Upgrade Operations Dashboard for ArcGIS.