← Back to xUI downloads

Register xUI in ArcGIS Enterprise Portal

Use the hosted xUI manifest to make xUI available as a custom widget in your ArcGIS Enterprise organization.

Production license required Development and evaluation are free. Purchase an xUI license before registering or deploying xUI for production use or making an xUI-enabled application available to end users.
ArcGIS Enterprise only Custom Experience Builder widget registration is supported in ArcGIS Enterprise 11.0 and later. ArcGIS Online does not currently support this workflow. Portal administrator privileges are required.

1. Confirm the requirements

2. Copy and test the manifest URL

  1. Open the xUI Downloads page.
  2. Expand the row matching your Experience Builder version.
  3. Choose the xUI release you want to register.
  4. Select Copy URL beside View manifest.
  5. Select View manifest and confirm the JSON opens without a sign-in prompt.

For example:

https://xui.blob.core.windows.net/v21/0.7.1/manifest.json
Use the manifest—not the ZIP The ZIP is for Experience Builder Developer Edition. Portal registration uses the public HTTPS address of the hosted manifest.json.
xUI Downloads page showing the View manifest and Copy URL controls
Copy the manifest URL for the xUI release that matches the target Experience Builder version.

3. Add the widget to Portal

  1. Sign in to your ArcGIS Enterprise Portal as an administrator.
  2. Select Content from the top navigation.
  3. Open My Content.
  4. Select New item or Add item, depending on your Enterprise version.
  5. Choose Application.
  6. Select Experience Builder widget.
  7. Paste the xUI manifest URL into the URL field.
  8. Click in the Title field. Portal should read the manifest and populate the title.
ArcGIS Enterprise My Content page with New item selected
Start from Content → My Content, then add a new item.
New item dialog with Experience Builder widget selected
Select Experience Builder widget as the application type and paste the complete HTTPS address ending in manifest.json. Press Next

Name the registered version clearly

Use a title that identifies both the xUI and Experience Builder versions:

xUI 0.7.1 — Experience Builder 1.21

Suggested tags:

xUI, Experience Builder, Custom Widget, EXB 1.21, xUI 0.7.1

Suggested summary:

xUI custom widget release 0.7.1 for ArcGIS Experience Builder 1.21.
A valid xUI production license is required for deployment.

Complete the form and select Add item or Save.

4. Share xUI with its users

  1. Open the new xUI item's details page.
  2. Select Share.
  3. Share it with the appropriate Portal groups or the organization.
  4. Share with everyone only when it is intentionally used by a public application.
  5. Select Save.
Sharing controls availability The widget must be registered in the same Portal organization as the experience and shared with the people who build or use it.

5. Verify xUI in Experience Builder

  1. Open Experience Builder from your Enterprise Portal.
  2. Create a test experience or edit an existing one.
  3. Open the Insert widget panel.
  4. Find the Custom group.
  5. Confirm xUI appears, then add it to the experience.
  6. Configure xUI and complete a functional test before using it in production.
Experience Builder Insert widget panel showing xUI in the Custom group
A successfully registered and shared xUI item appears in the Custom widget group.

6. Register a newer xUI release

Register each xUI release as a new Portal item instead of silently changing the previous registration:

Existing: xUI 0.7.1 — Experience Builder 1.21
New:      xUI 0.7.2 — Experience Builder 1.21
  1. Register the new version using its new manifest URL.
  2. Test the new widget in a nonproduction experience.
  3. Move applications to the new version through your normal release process.
  4. Retain the prior item temporarily for rollback.
  5. When it is no longer needed, unshare or remove the older item.

7. Troubleshooting

Portal cannot read the manifest

xUI does not appear in Experience Builder

xUI appears but does not load

Portal registration checklist