Skip To Content

Set advanced portal options

You can customize the behavior of portal using a configuration file. Properties you can set include whether certain links and buttons are shown on the website, for example, media links 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; for example, the following organizations might configure their portal in this way:

  • Defense Industry/Federal Government—Configure the entire portal to use local resources, add security banners, disable anonymous users from creating accounts, and disable forums, blogs, and sharing to social media.
  • Local Government—Add security banners, disable forums, and set the extent service to use a local projection.
  • Commercial—Enable forums, blogs, and sharing to social media.

The configuration file is located in <Portal for ArcGIS installation directory>/customizations/<version number>/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

  • addContentSecurityText—If not null, the text specified shows in the Search for layers to add dialog box when searching a GIS server to add layers to the map. The dialog box displays every time the user executes a search on a GIS server. The text can warn users about security constraints related to the content, for example, "For internal use only; do not distribute". The default is null.

  • bitlyUrl—If not null, short URLs for Facebook, Twitter, and URL map links display on the item details dialog box. If null, Twitter and Facebook links will not be available. To use this property, specify the full Bitly URL login and apiKey, such as http://api.bit.ly/v3/shorten?login=<loginName>&apiKey=<key>. The default is null. You must also set showSocialMediaLinks to true in order to use the Bitly URLs.

  • bitlyUrlSSL—If HTTPS is required, specify the full Bitly URL login and apiKey in this property, such as http://api.bit.ly/v3/shorten?login=<loginName>&apiKey=<key>. The default is null.

  • classificationBanner—Indicates if a security banner shows at the top and bottom of every page in the application. The default is false. To display a security banner, replace the classificationBanner:false line with code that defines your banner. The following is an example:

    classificationBanner : {
        text : "UNCLASSIFIED",
        color:[255,255,255],
        font:{
          decoration:"none",
          family:"Portable User Interface",
          size:16,
          style:"normal",
          weight:"bold"
        },
        height : 5,
        backgroundColor:[0,128,0]
      },

  • extentService—The service used to update or set the extent of a web map item in the Set Extent dialog box in the portal website. The default is http://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.

  • 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 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. 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. The default is true. When disabled, the option to search for layers in ArcGIS Online will be hidden from the Search for Layers dialog in Map Viewer. To disable the option to search for layers in ArcGIS Online from your portal, specify as false.

  • showCreateDashboard— Indicates whether Operations Dashboard items can be created from your portal. The default is false. When disabled, Operations Dashboard will be hidden from the Create Dashboard option in the My Content tab of the content page, and the app will not appear in the app launcher. To enable the ability to create Operations Dashboard items in your portal, and to have the app appear in the app launcher, specify as true.
  • showSocialMediaLinks—Indicates whether or not Facebook and Twitter links display on the item details dialog box. The default is false, meaning that the links do not display. To enable the links, specify this property as true, and specify the bitlyURL and bitlyURLSSL properties with the full Bitly URL login and apiKey, for example, "http://api.bit.ly/v3/shorten?login=<loginName>&apiKey=<key>",.
  • showWorkforce—Specifies whether the Workforce for ArcGIS application appears in the app launcher. The default is false. When set to true, Workforce will appear in the app launcher.

  • signInHelp—Use this property to override the page opened by the Need help signing in? link on the sign-in page (signin.html). The default is null, meaning that the default page (troubleshoot.html) is displayed by the link. To specify your own page, define the URL to the page that the link opens, for example, signInHelp: "http://machine.domain.com/mysignin.html",.

  • 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.

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

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