ArcGIS Experience Builder install

Install

The developer edition of ArcGIS Experience Builder supports ArcGIS Online and ArcGIS Enterprise 10.6 and later. There are two services for extending Experience Builder, the server and the client. You will need to have both services running to have your updates load in Experience Builder. To install the developer edition of Experience Builder, complete the following steps for the server install and client install. If you need to install Experience Builder without an internet connection, complete the offline install steps.

Server install

Create Client ID on ArcGIS Developers site

Use these steps if you're using developers.arcgis.com.

Experience Builder uses Node.js. Check the recommended Node version for the version of Experience Builder you are using, then download and install that version of Node.js for your operating system.

Note
You can also view the installation video for a walkthrough.
Download the developer edition of Experience Builder and unzip it on your local drive.
Sign in to ArcGIS for Developers.
Click the OAuth 2.0 tab.
Click + New Application and enter your application's details to register your new app.
Scroll down to the Redirect URLs tile.
Add the URL https://localhost:3001/.
Copy the Client ID.
Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
Type npm start to start the server.
Open Experience Builder at the following URL https://localhost:3001/ in your browser.

Tip
Experience Builder uses a self-signed certificate in Node.js to support HTTPS. You can run Experience Builder using this certificate by trusting it, or you can use your own certificate. To change the default certificate with your own, replace these two files in the server/cert directory: server.key and server.cert.
Specify the URL to your ArcGIS Online and add your Client ID > Sign in.
Install the client.

Create Client ID using ArcGIS Online or ArcGIS Enterprise

Use these steps if you're using ArcGIS Online or ArcGIS Enterprise.

Experience Builder uses Node.js. Check the recommended Node version for the version of Experience Builder you are using, then download and install that version of Node.js for your operating system.

Note
You can also view the installation video for a walkthrough.
Download the developer edition of Experience Builder and unzip it on your local drive.
Log in to your ArcGIS Online or ArcGIS Enterprise portal and go to My Content tab of the content page, click New Item, and select Application.
Select Other application option and click Next.
In the New item dialog box, enter the following parameters:
- Title - Enter something that makes sense to you, such as Experience Builder credentials.
- Tags - Optionally enter something such as Experience Builder.
- Select a folder and optionally fill Categories and Summary if necessary
- Click Save to add
Click the Manage button at the Credentails section.
On the Redirect URI section, click Add to enter https://localhost:3001/. Copy the App ID at Credentail section.
Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
Type npm start to start the service.

Tip
To use custom ports, you can pass them as options like this: npm start -- --port 81 --https_port 443.
To run the server at a subdirectory (e.g. https://localhost:3001/subfolder), you can pass the path option like this: npm start -- --path /subfolder.
Open Experience Builder at the following URL https://localhost:3001/ in your browser.

Tip
Experience Builder uses a self-signed certificate in Node.js to support HTTPS. You can run Experience Builder using this certificate by trusting it, or you can use your own certificate. To use your own certificate, replace these two files in the server/cert directory: server.key and server.cert. Alternatively, you may pass in a custom path to the folder in which the certificate files (server.cert and server.key) reside, like this: npm start -- --cert_folder <folder path>
Specify the URL to your ArcGIS Online or ArcGIS Enterprise organization, and add your App ID for the Client ID > Sign in.

Tip
In Safari, signing in to developer edition of Experience Builder with PKI, Kerberos, IWA, or LDAP authentication types requires selecting Disable Cross-Origin Restrictions (in Safari's develop menu).
Install the client.

Client install

To develop with Experience Builder, a service must be installed to launch webpack to help with bundling and loading your custom widgets and themes used in your local Experience Builder.

Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
Type npm start to start the service.

Tip
New files/folders created in the client/your-extensions directory will require a restart of the client server.

You can have multiple versions of the developer edition of Experience Builder on the same machine. Please check that your machine meets the System requirements.

Offline install

In a disconnected environment you will not have access to the ArcGIS API JavaScript (JSAPI) CDN. In this scenario, you will be required to download the JSAPI and install it locally.
Experience Builder uses Node.js. Check the recommended Node version for the version of Experience Builder you are using, then download and install that version of Node.js for your operating system.

Note
It is suggested to install latest version of ArcGIS API JavaScript to support enhancements and new features in Experience Builder. You can also view the offline installation video for a walkthrough. It is also suggested that you setup CORS support on your server for the hosted JSAPI. For example, with Windows OS, you can add Access-Control-Allow-Origin action in HTTPS Response Header.
Download the developer edition of Experience Builder and unzip it on your local drive.
Download the npm-cache zip for the developer edition of Experience Builder and unzip it on your local drive.
Open your user folder (e.g., Windows OS c:\Users\exbuser) in a command prompt or terminal (e.g., macOS /Users/installExB) and type npm config get cache.
Copy the folder path of the npm-cache and open that directory in Windows Explorer or Finder.
Copy and paste the npm-cache directory (from step 3) into this directory.
Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, type npm install --offline, and hit enter.
Open another command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm install --offline, and hit enter.
Open the client directory for your Experience Builder at the following path <install folder>/client/dist.
There are four places you will need to update the variable arcgisJsApiUrl with your local JSAPI host URL. For example, replace var arcgisJsApiUrl = 'https://js.arcgis.com/4.29/' with var arcgisJsApiUrl = 'https://exb.esri.com/4.29/' in each of the files below:
- <install folder>/client/dist/index.html
- <install folder>/client/dist/experience/index.html
- <install folder>/client/dist/template/index.html
- <install folder>/client/dist/builder/index.html
Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, and type npm start to start the client service.
Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, and type npm start to start the server service.

Tip
Experience Builder requires a connection to ArcGIS Online or ArcGIS Enterprise portal to create a Client ID.
Log in to your ArcGIS Online or ArcGIS Enterprise portal and go to My Content tab of the content page, click New Item, and select Application.
Select Other application option and click Next.
In the New item dialog box, enter the following parameters:
- Title - Enter something that makes sense to you, such as Experience Builder credentials.
- Tags - Optionally enter something such as Experience Builder.
- Select a folder and optionally fill Categories and Summary if necessary
- Click Save to add
Click the Settings tab. Scroll down to the App Registration section and click Update.
On the Register Info dialog box as shown below, enter in https://localhost:3001/ for the Redirect URI, and click Add > Update. Copy the App ID.
Open Experience Builder at the following URL https://localhost:3001/ in your browser.
Specify the URL to your ArcGIS Online or ArcGIS Enterprise organization and add your App ID for the Client ID > Sign in.

Install as a Windows Service

Download and install the latest Node.js LTS version for your operating system.
Open Windows command prompt as administrator.
Change the directory (cd) to the /server directory of Experience Builder.
Run the command npm ci to install the dependencies.
Run the command npm run install-windows-service.
Open the Windows Services app and start the Experience Builder service (default name: exb-server).
To remove the Experience Builder service, run the command npm run uninstall-windows-service.

ArcGIS Experience BuilderGuide

ArcGIS Experience Builder install

Was this page helpful?