ArcGIS Experience Builder install
Install
ArcGIS Experience Builder Developer Edition 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 for 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 runs on top of Node.js 12+.x, download and install Node.js (v12+.x) for your operating system.
- Download the Experience Builder Developer edition and unzip it on your local drive.
- Sign to ArcGIS for Developers.
- Click
New Application
. - In the
New Applications Details
, enter the following:Title
- Enter something that makes sense to you, such asExperience Builder credentials
.Tags
- Enter something such asExperience Builder
.- Click
Register New Application
.
- Click the
Authentication
tab for the application you just registered. In theCurrent Redirect URIs
section, enter inhttps://localhost:3001/
for the Redirect URI, and click+ Add
.
- 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.
- 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 runs on top of Node.js 12+.x, download and install Node.js (v12+.x) for your operating system.
- Download the Experience Builder Developer edition 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, clickAdd Item
, and selectAn application
. - In the
Add an application
dialog box, enter the following parameters:Type
- SelectApplication
as the type.Title
- Enter something that makes sense to you, such asExperience Builder credentials
.Tags
- Enter something such asExperience Builder
.- Click
Add Item
.
- Click the
Settings
tab. Scroll down to theApp Registration
section and clickUpdate
. - On the
Register Info
dialog box, as shown below, enter inhttps://localhost:3001/
for theRedirect URI
, and clickAdd
>Update
. Copy theApp 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 service. - 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 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.
You can have multiple versions of the Developer edition 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 runs on top of Node.js 12+.x, download and install Node.js (v12+.x) for your operating system.
- Download the Experience Builder Developer edition and unzip it on your local drive.
- Download the npm-cache zip for the Experience Builder Developer edition 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 typenpm 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, replacevar arcgisJsApiUrl = 'https://js.arcgis.com/4.17/'
withvar arcgisJsApiUrl = 'https://exb.esri.com/4.17/'
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.
- Log in to your ArcGIS Online or ArcGIS Enterprise portal and go to the
My Content
tab of the content page. ClickAdd Item
and selectAn application
. - In the
Add an application
dialog box, enter the following parameters:Type
- SelectApplication
as the type.Title
- Enter something that makes sense to you, such asExperience Builder credentials
.Tags
- Enter something such asExperience Builder
.- Click
Add Item
.
- Click the
Settings
tab. Scroll down to theApp Registration
section and clickUpdate
. - On the
Register Info
dialog box as shown below, enter inhttps://localhost:3001/
for theRedirect URI
, and clickAdd
>Update
. Copy theApp 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.