Skip To Content

Set advanced portal options

You can customize the behavior of the portal using a configuration file. Properties you can set include whether certain apps and buttons are shown on the website, for example, links to the Scene Viewer app or a button that allows anonymous users to create portal accounts. You may want to do this if you're configuring a disconnected deployment or modifying the portal's behavior to match the requirements of your organization.

The configuration file is located in <Portal for ArcGIS installation directory>/customizations/<version number>/framework/webapps/arcgis#home/js/arcgisonline/config.js. Make a backup copy of this file before modifying it.

After you modify the properties in the file, restart your portal to apply your edits and clear your browser's cache (including cookies) to see the changes in the portal website.

Note:

When you install a patch, system update, or upgrade your portal to a newer version, the config.js file is preserved in the customizations directory, and the properties you modified in the file persist. As a safeguard, keep a copy of the config.js file in case the customizations directory is accidentally deleted by a member of your organization.

The configuration file contains other code that should not be modified. When you open the configuration file, browse to the section of the file that contains modifiable properties. Some of the properties in the portal configuration file are self-explanatory, but some selected properties are described in more detail below. The properties are listed in alphabetical order.

Properties in the configuration file

  • extentService—The service used to update or set the extent of a web map item on the Set Extent dialog box in the portal website. The default is http://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer. The service must use the WGS 1984 geographic coordinate system with well-known ID (WKID) 4326 and be a tiled map service.

  • footerLinks—You can use this property to define links displayed on all page footers. The following example displays links to several pages—Organization, Terms of Use, Privacy, Contact Us, and Report Abuse:

    footerLinks: [{
          title: "Organization",
          url: "http://www.myorganiz.com"
        }, {
          title: "Terms of Use",
          url: "http://www.myorganiz.com/legal/licensing/termsofuse.html"                        
        }, {
          title: "Privacy",
          url: "http://www.myorganiz.com/legal/privacy.html"                                     
        }, {
          title: "Contact Us",
          email: "feedback@myorganiz.com",
          type: "contactUs"
        }, {
          title: "Report Abuse",
          email: "feedback@myorganiz.com",
          type: "reportAbuse"
        }],

  • gcsBasemapService—The service to be used as the basemap for OGC WMS services that do not support the Web Mercator coordinate system. The default is http://services.arcgisonline.com/ArcGIS/rest/services/ESRI_Imagery_World_2D/MapServer.

  • httpsDomains—Use this property to list federated servers so that Map Viewer Classic can switch services from federated servers in a web map from using HTTP to HTTPS. This will help avoid mixed content issues in Map Viewer Classic. Use the format ["arcgis.com","arcgisonline.com","server.domain.com"].

  • longTokenExpiration—When a user signs in to the portal website and selects Keep me signed in, a token generates with a default expiration time of 20,160 minutes (14 days). If the user does not select the Keep me signed in option when signing in, the tokenExpiration time overrides the time defined in this property.

  • restrictOrganizationPageToAdmin—Indicates whether the Organization page is visible to members of the portal. The default is false, meaning the Organization page is visible to all members of the portal. To hide the Organization page from all users except members of the default Administrator role, specify as true.

  • searchArcGISOnlineEnabled—With this property, you can enable the option to search for layers in ArcGIS Online from your portal's Map Viewer Classic. The default is true. When disabled, the option to search for layers in ArcGIS Online is hidden from the Search for Layers dialog box in Map Viewer Classic. To disable the option to search for layers in ArcGIS Online from your portal, specify as false.

  • showCreateDashboard—Indicates whether ArcGIS Dashboards is accessible in your portal. The default is true. To disable Dashboards in your portal, specify as false. When disabled, Dashboards is hidden from the Share dialog box in Map Viewer Classic, from the Create Web App option on item details pages, and from the Create App option on the My Content tab of the Content page.

  • showInAppLauncher—Use this property to list the Esri applications to display in the app launcher, separating entries with a comma. The default string is ["ArcGIS Dashboards", "ArcGIS Enterprise Sites", "Track Viewer","Ortho Maker","ArcGIS Workforce","ArcGIS QuickCapture Web Designer","ArcGIS StoryMaps","ArcGIS Experience Builder","ArcGIS Field Maps", "ArcGIS Map Viewer", "ArcGIS Map Viewer Classic", "ArcGIS Dashboards Classic"]. You can remove any of these apps from the list and the app launcher.

  • sceneViewerEnabled—Indicates whether Scene Viewer is accessible in your portal. The default is true. When disabled, Scene Viewer options are hidden from all dialog boxes and ribbons in the portal. To disable Scene Viewer in your portal, specify as false.

  • surveyUrl—Use this property to access the ArcGIS Survey123 website. You can replace the URL with either a link to an installed Survey123 website, including any port numbers, or a reverse proxy access point.

  • tokenExpiration—When a user signs in to the portal website, a token generates with a default expiration time of 120 minutes (two hours). If the user selects the Keep me signed in option when signing in, the longTokenExpiration time overrides the time defined in this property.

  • webAppBuilderEnabled—Indicates whether ArcGIS Web AppBuilder is accessible in your portal. The default is true. When disabled, Web AppBuilder is hidden from the Share dialog box in Map Viewer Classic and from the Create App option on the My Content tab of the content page. To disable ArcGIS Web AppBuilder in your portal, specify as false.

Note:

At 10.8 and later versions, an information banner can be configured in the organization settings of the portal that replaces the workflow to set the classificationBanner property in the configuration file.