1. Get started

  2.  Welcome
  3.  Get started
  4.  Run as a Windows service
  5.  Build your first app
  6.  Requirements
  7.  Accessibility support
  8.  Development overview
  9.  About release versions
  10.  What's new
  11.  Frequently asked questions
  12. Working with apps

  13.  Home page
  14.  Create or import an app
  15.  Edit and launch an app
  16.  Choose a theme
  17.  Select a map or scene
  18.  Add widgets
  19.  Widgets overview
  20.  Configure app attributes
  21.  Preview apps on smaller screens
  22.  Export as a template
  23.  Edit or preview template
  24.  Use URL parameters
  25.  Upgrade apps
  26. Configure 2D widgets

  27.  About widget
  28.  Add Data widget
  29.  Analysis widget
  30.  Attribute Table widget
  31.  Batch Attribute Editor widget
  32.  Basemap Gallery widget
  33.  Bookmark widget
  34.  Business Analyst widget
  35.  Chart widget
  36.  Controller widget
  37.  Coordinate widget
  38.  Coordinate Conversion widget
  39.  Cost Analysis widget
  40.  Data Aggregation widget
  41.  Directions widget
  42.  Distance and Direction widget
  43.  District Lookup widget
  44.  Draw widget
  45.  Edit widget
  46.  Emergency Response Guide widget
  47.  Extent Navigate widget
  48.  Filter widget
  49.  Full Screen widget
  50.  Geocoder widget
  51.  GeoLookup widget
  52.  Geoprocessing widget
  53.  Grid Overlay widget
  54.  Gridded Reference Graphic widget
  55.  Group Filter widget
  56.  Image Measurement widget
  57.  Home Button widget
  58.  Incident Analysis widget
  59.  Infographic widget
  60.  Info Summary widget
  61.  Layer List widget
  62.  Legend widget
  63.  Measurement widget
  64.  My Location widget
  65.  Near Me widget
  66.  Network Trace widget
  67.  Oblique Viewer widget
  68.  Overview Map widget
  69.  Parcel Drafter widget
  70.  Print widget
  71.  Public Notification widget
  72.  Query widget
  73.  Related Table Charts widget
  74.  Report Feature widget
  75.  Reviewer Dashboard widget
  76.  Scalebar widget
  77.  Screening widget
  78.  Search widget
  79.  Select widget
  80.  Share widget
  81.  Situation Awareness widget
  82.  Smart Editor widget
  83.  Splash widget
  84.  Stream widget
  85.  Suitability Modeler widget
  86.  Summary widget
  87.  Swipe widget
  88.  Threat Analysis widget
  89.  Time Slider widget
  90.  Visibility widget
  91.  Zoom Slider widget
  92. Configure 3D widgets

  93.  3DFx widget
  94.  About widget
  95.  Basemap Gallery widget
  96.  Compass widget
  97.  Coordinate widget
  98.  Daylight widget
  99.  Full Screen widget
  100.  Home Button widget
  101.  Layer List widget
  102.  Legend widget
  103.  Measurement widget
  104.  My Location widget
  105.  Navigate widget
  106.  Search widget
  107.  Share widget
  108.  Slides widget
  109.  Splash widget
  110.  Zoom Slider widget
  111. Widget development

  112.  Get started
  113.  Naming conventions
  114.  In-panel and off-panel widgets
  115.  Deploy your widget
  116.  Required files
  117.  Widget manifest
  118.  Extend BaseWidget
  119.  Required properties
  120.  Define the template
  121.  Configure the Demo widget
  122.  Add i18n support
  123.  Make widgets user-friendly
  124.  Build your first app
  125.  Communication to app container
  126.  Widget properties
  127.  Make widgets responsive
  128.  Communication between widgets
  129.  Dojo dijit
  130.  Make widgets configurable in builder
  131.  Make widgets backward compatible
  132.  Create a controller widget
  133.  Widget life cycle
  134.  Add help for your widget
  135.  Create a feature action in your widget
  136.  Provide and consume data sources in widgets
  137.  Best practices for unit testing
  138. Theme development

  139.  Theme elements
  140.  Create a theme
  141. 3D development

  142.  3D development guide
  143. Sample code

  144.  Create a custom in-panel widget
  145.  Create a ListView widget
  146.  Create a custom widget using the Report dijit
  147.  Create a new theme
  148.  Create a new style for a theme
  149.  Create a new default layout
  150.  Create a nondefault layout
  151.  Create a new panel
  152.  Create a new layout widget
  153.  Create a controller widget
  154.  Create a feature action in your widget
  155.  Send a layer to the Attribute Table widget
  156.  Open multiple widgets simultaneously
  157.  Use other libraries
  158.  Change the URL of ArcGIS API for JavaScript
  159. Deployment

  160.  Deploy your app
  161.  Use proxy
  162.  Web-tier authentication
  163.  Custom widget and theme deployment
  164.  Upgrade custom widgets and themes
  165. Framework reference

  166.  CSS framework
  167.  FeatureActionManager class
  168.  FilterManager class
  169.  LayerInfo class
  170.  LayerInfos class
  171.  LayerNode class
  172.  LayerStructure class
  173.  PanelManager class
  174.  SelectionManager class
  175.  Utils class
  176.  WidgetManager class
  177. dijit

  178.  FeaturelayerChooserFromMap class
  179.  FeaturelayerServiceBrowser class
  180.  FeatureSetChooserForSingleLayer class
  181.  Filter class
  182.  ImageChooser class
  183.  ItemSelector class
  184.  LayerChooserFromMap class
  185.  RendererChooser class
  186.  Report class
  187.  SnapShot class
  188.  SymbolChooser class
  189. JSON reference

  190.  App configuration
  191.  Map configuration
  192.  Widget configuration
  193.  Widget pool configuration
  194.  Widget on-screen configuration
  195.  Panel configuration
  196.  Group configuration
  197.  DataSource configuration
  198.  About
  199.  Analysis
  200.  Attribute Table
  201.  Basemap Gallery
  202.  Bookmark
  203.  Chart
  204.  Coordinate
  205.  Directions
  206.  Draw
  207.  Edit
  208.  Full Screen
  209.  Geocoder
  210.  Geoprocessing
  211.  Controller
  212.  Home Button
  213.  Image Measurement
  214.  Infographic
  215.  Layer List
  216.  Legend
  217.  Loading Page
  218.  Measurement
  219.  My Location
  220.  Near Me
  221.  Oblique Viewer
  222.  Overview Map
  223.  Print
  224.  Query
  225.  Report Feature
  226.  Reviewer Dashboard
  227.  Scalebar
  228.  Search
  229.  Share
  230.  Splash
  231.  Stream
  232.  Swipe
  233.  Time Slider
  234.  Zoom Slider
  235. What's new archive

  236.  What's new in version 2.23
  237.  What's new in version 2.22
  238.  What's new in version 2.21
  239.  What's new in version 2.20
  240.  What's new in version 2.19
  241.  What's new in version 2.18
  242.  What's new in version 2.17
  243.  What's new in version 2.16
  244.  What's new in version 2.15
  245.  What's new in version 2.14
  246.  What's new in version 2.13
  247.  What's new in version 2.12
  248.  What's new in version 2.11
  249.  What's new in version 2.10
  250.  What's new in version 2.9
  251.  What's new in version 2.8
  252.  What's new in version 2.7
  253.  What's new in version 2.6
  254.  What's new in version 2.5
  255.  What's new in version 2.4
  256.  What's new in version 2.3
  257.  What's new in version 2.2
  258.  What's new in version 2.1
  259.  What's new in version 2.0
  260.  What's new in version 1.3
  261.  What's new in version 1.2
  262.  What's new in version 1.1

Frequently asked questions

How do I start ArcGIS Web AppBuilder (developer edition)?

What should I do when I try to set the app ID and encounter an Invalid redirect_uri error?

It is indicated that the URI of Web AppBuilder is not added or set correctly in the Redirect URI list when you registered the app ID for Web AppBuilder in your ArcGIS Enterprise portal. Complete the following steps:

  1. Browse to the /server directory of the Web AppBuilder installation and delete the signininfo.json file.
  2. Review step 4 and update the existing app ID with the correct redirect URIs. See View and update app registration info. Alternatively, you can create a new app ID from scratch.
  3. Refresh the browser running Web AppBuilder.
  4. Provide your app ID again and click Continue.

NoteNote:

If your portal only accepts CORS requests from specified domains, add the machine hosting Web AppBuilder (developer edition) to the portal's allowed origins list. Otherwise, after users sign in via the OAuth prompt, Web AppBuilder redirects back to https://:3344/webappbuilder/?action=setportalurl instead of accessing the app on your portal.

How do I start Web AppBuilder (developer edition) in HTTPS websites with my CA-signed certificate?

Web AppBuilder uses a self-signed certificate in Node.js to support HTTPS. If you want to start Web AppBuilder in your full HTTPS site, you can use your own certificate. To do so, replace two files in the server directory: cakey.pem and cacert.pem. See Node.js and https://www.openssl.org/docs/faq.html#USER3 for more information.

How do I use the local help?

You can start the Web AppBuilder help in a browser with https://[yourmachinename]:[port]/webappbuilder/help after Node.js starts, or go to the docs folder for the Web AppBuilder installation by right-clicking the index.html file, and then open it with Firefox. You may need to enable JavaScript.

What should I do when I fail to log in to my ArcGIS Online organization or my ArcGIS Enterprise portal?

You may fail to log in to your ArcGIS Online organization or your ArcGIS Enterprise portal due to one of the following:

  • No trusted certification available. To work around it, log in to your portal first to make the certificate trusted, and then log in to Web AppBuilder again.
  • Need proxy to access externally. To work around it, set the proxy for Web AppBuilder from node command node server.js [-proxy=value].

How can I update the app ID for Web AppBuilder (developer edition)?

The app ID is set when you start Web AppBuilder for the first time. To update it, open the signininfo.json file in the server folder, and then edit the appID property specified in the portal.

Is SSL-enabled access supported?

Yes. Web AppBuilder supports SSL-enabled access to online organizations or ArcGIS Enterprise. The HTTPS request is required when the URL to the organization or portal is specified.

Which portal securities are supported?

Portals with the following securities are supported by Web AppBuilder:

  • OAuth
  • SAML
  • IWA
  • PKI
  • LDAP

What should I do when I fail to start Web AppBuilder by specifying a URL to a portal with LDAP authentication?

When you start Web AppBuilder by specifying a URL to a portal with LDAP authentication, you may encounter this error: Unable to access [Portal_URL]. A Server with specified hostname could not be found. This is probably caused by the SSL support in the node server not matching the SSL version of the LDAP server. To work around it, stop the node server, and then start it with command lines.

On 64-bit Windows, type node_x64.exe server.js -sslClientVersion=SSLv3_method.

On 32-bit Windows, type node_x32.exe server.js -sslClientVersion=SSLv3_method.

On other platforms, type node server.js -sslClientVersion=SSLv3_method.

Open a command window and browse to the server directory of the Web AppBuilder installation.

Are portals with disconnected environments supported?

Yes. You must set your own apiURL manually in the env.js file. Refer to Change URL of ArcGIS API for JavaScript. By default, Web AppBuilder points to the ArcGIS API for JavaScript hosted by ArcGIS.com.

Why can't my deployed app access cross-domain resources?

You need to set the appropriate proxy in the app config.json file. Refer to Use proxy.

Do I have to register my downloaded app for deployment?

The app created by Web AppBuilder can be downloaded and hosted on your web server. Any app that is downloaded must be registered with ArcGIS Online or ArcGIS Enterprise if the app references nonpublic items. Refer to Deploy app.

Which versions of ArcGIS Enterprise should I use?

Web AppBuilder supports Portal for ArcGIS 10.3 and later, including all versions of ArcGIS Enterprise. If you have Portal for ArcGIS 10.2.2 or 10.2.1, it is recommended that you upgrade to ArcGIS Enterprise 11.1 and later.

Which versions of ArcGIS API for JavaScript should I use?

Web AppBuilder 1.0 began supporting ArcGIS API for JavaScript at 3.12. In subsequent releases, the latest release of Web AppBuilder always synchronizes with the latest release of ArcGIS API for JavaScript. To get the latest version of ArcGIS API for JavaScript that is supported by the latest release of Web AppBuilder, see Requirements and browser support.

What should I do if I received the error message "failed to create the app"?

Please make sure the JSON file is enabled in your IIS server.

How do I start ArcGIS Web AppBuilder (developer edition) as a service in Linux?

The developer edition of Web AppBuilder is run as a node app in Linux. You can manage Web AppBuilder with PM2. The following are detailed steps:

  1. Install pm2 using command $ npm install pm2 -g.
  2. Navigate to the Server folder of Web AppBuilder.
  3. Run pm2 start server.js.

    This will add Web AppBuilder application to PM2's process list. PM2 automatically assigns an App name (based on the filename, without the .js extension) and a PM2 id. PM2 also maintains other information, such as the PID of the process, its current status, and memory usage.

  4. To launch the application, run pm2 startup systemd in the command window.

    NoteNote:

    You must run this command with super user privileges.

    After that, PM2 will generate a command.

  5. Run the newly generated command to set PM2 up to start on boot (use the command from your own output).