Web AppBuilder for ArcGIS (Developer Edition)

Frequently asked questions

How do I start Web AppBuilder for ArcGIS (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.

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 http://[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 or Internet Explorer (IE). If you choose the latter option, be aware that Chrome does not support this HTML format, while with IE10 or later, you need to enable JavaScript before continuing.

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 if I have an error when running Web AppBuilder on Microsoft Edge?

Edge runs as a Windows modern app different from IE, and thus it has network isolation by default for security reasons. If you receive an error saying Hmm, we can't reach this page, read the blog for a solution.

Can I use Web AppBuilder (Developer Edition) with IE8 or IE9 to access portals with web-tier authentication?

No. Web AppBuilder (Developer Edition) does not support using IE8 or IE9 to access the portal with web-tier authentication. This is due to the limitation of IE8 and IE9 not supporting Cross-Origin Resource Sharing (CORS).

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 10.7 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 Web AppBuilder for ArcGIS (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 AppBuilderapplication 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.


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