Business Analyst widget

The Business Analyst widget allows users to visualize key indicators and information about a specific location using interactive infographics. Users can select and interact with ready-to-use Esri infographic templates or create custom templates in ArcGIS Business Analyst Web App (Advanced) in ArcGIS Online or ArcGIS Business Analyst Enterprise.Learn how to build infographic templates that you can use in Experience Builder.

The widget has two modes: Workflow and Preset. Workflow mode allows users to search for a location or geographic boundary and select infographics to run for that location. With Preset mode, you predefine a specific site and infographic for the user.

Examples

Use this widget to support app design requirements such as the following:

• You want hospital administrators who are considering whether to open a new clinic to understand health and insurance information for an area.
• You want city planners to take demographic data into account while choosing the location for a new school.
• You want public health authorities to generate reports for specific districts.

Usage notes

To create an Experience Builder app with the Business Analyst widget, you must be signed in with an ArcGIS account that has privileges for GeoEnrichment and Network Analysis. These privileges are also required to use the Business Analyst widget in an app at run time. To allow members of your organization or the public to use the widget at run time, you can configure the widget with a custom ArcGIS Online GeoEnrichment utility service.

Using this widget with the ArcGIS Online GeoEnrichment utility service consumes organization credits.

• Viewing infographics with the widget consumes 10 credits per 1,000 views.
• Exporting infographics to PDF, Excel, or HTML consumes 10 credits per export.

You can choose which export options are available to users at run time in the widget's settings under Infographic settings.

Using this widget with ArcGIS Business Analyst Enterprise does not consume credits.

GeoEnrichment

This widget requires a GeoEnrichment service. How you configure the GeoEnrichment service depends on the ArcGIS Online organization or ArcGIS Enterprise URL that you specify when you set up the developer edition of Experience Builder.

• If you specify an ArcGIS Enterprise portal URL that has ArcGIS Business Analyst Enterprise, the Business Analyst widget works with your portal's GeoEnrichment service. All infographic templates published to your portal, including custom templates (My Infographics and Shared Infographics), are available to use with the Business Analyst widget.
• If you specify an ArcGIS Enterprise portal URL without ArcGIS Business Analyst Enterprise, you must first configure your portal with the ArcGIS OnlineGeoEnrichment utility service. With this configuration, only the default Esri Infographic templates are available to use with the Business Analyst widget. Gallery and custom infographic templates are not available.
• If you specify an ArcGIS Online organization URL, no additional steps are required to configure a GeoEnrichment service. The widget uses the default ArcGIS OnlineGeoEnrichment utility service. With this configuration, you have access to all categories of infographic templates (Esri Infographics, Gallery Infographics, My Infographics, and Shared Infographics).

Add a custom GeoEnrichment utility service by URL

To add a custom GeoEnrichment service to your ArcGIS organization and then to your app, follow these steps:

1. Navigate to the Content tab in your ArcGIS account.
2. Click New item and choose URL.
3. Enter the following URL: https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer .
4. Turn on Store credentials with service item.
5. Click Next.
6. Enter the username and password for your ArcGIS account.
7. Optionally, change the share settings of the GeoEnrichment utility item to share it with your organization or public users.
8. On the utility service's item page, copy the item URL.
9. In Experience Builder and in the Business Analyst widget's settings under GeoEnrichment, click Select utility.
10. In the Select utility panel, click Add utility. Enter the utility service URL in the text box.

It is recommended that you consider whether you want to share the app and the custom GeoEnrichment utility service publicly because the utility service consumes organization credits. If the custom GeoEnrichment utility service is shared publicly, the widget does not prompt users to sign in. If it is shared with the organization, all members, including those without GeoEnrichment privileges, can use the widget if they are signed in.

Settings

The Business Analyst widget includes the following settings:

• Mode—Select one of two layout modes for the widget based on what kind of user experience you want to provide.

  • Workflow—This mode guides users through searching for a location or geographic boundary, creating buffers for a point location, and selecting an infographic to run.

    • Select a Map widget (Optional)—Connect a Map widget. This allows users to click the map to drop a pin, select point and polygon features, or search the map. To select features from a map, you must configure the Map widget's action trigger. If there is a Map widget on the canvas, it is automatically selected.

    • Search—Add the Business Analyst widget's search tool to the map.

    • Drawing tools—Include the Point and Polygon drawing tools, both of which allow users to create an input location for the infographic.

    • Location settings—Configure settings related to how the user selects an input location for the infographic at run time.

      • Country or region—Select a country or region from the drop-down list. Once you select a country or region, the Customize infographics and Customize search panels only display infographics and geographies available for that country or region.

      • Data source—Select a data vintage or data source. The drop-down menu lists available data for the selected country or region. Learn more about data sources.

      • Customize search—Open the Customize search window.

        • Allow search—Turn on this setting to allow users to search for a location. If you leave this setting turned off, the search tool is hidden and you must predefine a location for the user or connect a Map widget so the user can select features.
        • Introductory text—Choose to provide introductory text for the search step. You may use this setting to provide instructions or a search suggestion.
        • Search control—Choose to allow users to search for points of interest and geographies in the selected country or region. The available types of geographies (such as States, Statistical Areas, and ZIP codes) depend on which country or region you select. At least one of the check boxes, either Points of interest or Geographies, must always be checked.

    • Buffers—Click the Customize buffers button to open the Customize buffers window, which contains settings for customizing the buffer options available to the user at run time.

      • User-configurable buffers—Turn on this setting to allow users to customize buffer settings at run time. The infographic displays information about the area within the buffers. If you leave this setting turned off, the default buffers you set are unchangeable by the user.

        • Introductory text—Provide introductory text or additional instructions for the buffer tool.

      • Default settings—Customize the default buffer settings. If you turn on User-configurable buffers, users can change these values. You can create buffers in the following ways:

        • Rings in miles or kilometers. The limits for ring size are 1,000 miles and 1,000 kilometers.
        • Drive time in minutes, miles, or kilometers, based on road networks. The limits for drive time are 300 minutes, 300 miles, and 482.8 kilometers.
        • Walk time in minutes, miles, or kilometers, based on paths and roads that allow pedestrian traffic. The limits for walk time are 300 minutes, 27 miles, and 43.45 kilometers.

      • Show increment buttons—Include increment and decrement buttons for changing the buffer values at run time.

      • Drive time options—Add the drive time options drop-down menu to the buffer tab. You can configure the following drive time settings:

        • Mode—Choose one of the following travel modes to be the default travel mode. All will be available as choices in a drop-down menu at run time.

          • Driving time—Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time. Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars.
          • Rural driving time—Similar to Driving time, except this mode does not discourage travel on unpaved roads.
          • Trucking time—Models basic truck travel by preferring designated truck routes and finds solutions that optimize travel time. Routes must obey one-way roads, avoid illegal turns, and so on. Trucking speed is based on either historical average speeds for automobiles or the posted speed limits for trucks, whichever is lower. Follows rules applicable to heavy trucks.

        • You must choose a default travel direction to use to calculate the drive time buffer, either Away from facility or Toward facility.

        • Use traffic—Allow users to take traffic into account in drive time buffer calculations.

          • You must choose a default method for calculating traffic, either Live traffic or Typical traffic.

          • Time Offset—Choose a default value for the time offset drop-down menu. All will be available as choices at run time. Users can offset live traffic conditions by up to 12 hours from the current time, in 15-minute increments. For typical traffic, users can select a day of the week and time.

    • Infographics—Click the Customize infographics button to open the Customize infographics window, which contains settings for customizing the list of infographics available to the user at run time.

      • Allow infographic choice—Turn on this setting to allow users to select any infographic from the available list. If you leave this setting turned off, the infographic you select is the default unchangeable infographic, and the Infographic tab is hidden.

        • Introductory text—Provide introductory text or additional instructions for the infographics tool.

      • Select infographics—Select one or more infographics to be available as choices for users at run time. You can choose infographics from the following lists:

        • Esri Infographics—Ready-to-use templates from Esri.
        • Gallery Infographics—Additional ready-to-use templates from Esri. Only available for some locations.
        • Shared Infographics—Templates created in ArcGIS Business Analyst Web App and shared with you or your organization.
        • My Infographics—Templates created by you in ArcGIS Business Analyst Web App.

      • Default infographic—Select a default infographic. At run time, this infographic appears selected on the Infographic tab when the widget loads.

  • Preset—This mode allows you to set a specific infographic with preconfigured location or geography settings.

    • Introductory text—Provide meaningful introductory text. You can use this setting to provide instructions or a search suggestion.

    • Select a Map widget (Optional)—Connect a Map widget. This allows users to click the map to drop a pin, select point and polygon features, or search the map. To select features from a map, you must configure the Map widget's action trigger. If there is a Map widget on the canvas, it is automatically selected.

    • Search—Add the Business Analyst widget's search tool to the map.

    • Location settings—Configure settings related to the input location for the infographic.

      • Country or region—Select a country or region from the drop-down list. Once you select a country or region, the Select an infographic panel only displays infographics available for that country or region.

      • Data source—Select a data vintage or data source. The drop-down menu lists available data for the selected country or region. Learn more about data sources.

      • Set a location—Open the Set a location window.

        • Preset location or geography—Define a default location for which to populate the infographic. The default location can be a point, such as an address, or a geographic boundary, such as the borders of a city or county.

    • Buffers—Click the Set buffers button to open the Set buffers window.

      • Set buffers—Choose how the widget calculates buffer distances. The buffers surround the preset or user-selected location, and the infographic displays information about the areas within the buffers. You can create buffers in the following ways:

        • Rings in miles or kilometers. The limits for ring size are 1,000 miles and 1,000 kilometers.

        • Drive time in minutes, miles, or kilometers, based on road networks. The limits for drive time are 300 minutes, 300 miles, and 482.8 kilometers.

        • Walk time in minutes, miles, or kilometers, based on paths and roads that allow pedestrian traffic. The limits for walk time are 300 minutes, 27 miles, and 43.45 kilometers.

        • Drive time options—You can configure the following drive time settings:

          • Mode—Choose one of the following travel modes to be the default travel mode. All will be available as choices in a drop-down menu at run time.

            • Driving time—Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time. Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars.
            • Rural driving time—Similar to Driving time, except this mode does not discourage travel on unpaved roads.
            • Trucking time—Models basic truck travel by preferring designated truck routes and finds solutions that optimize travel time. Routes must obey one-way roads, avoid illegal turns, and so on. Trucking speed is based on either historical average speeds for automobiles or the posted speed limits for trucks, whichever is lower. Follows rules applicable to heavy trucks.

          • You must choose a default travel direction to use to calculate the drive time buffer, either Away from facility or Toward facility.

          • Use traffic—Allow users to take traffic into account in drive time buffer calculations.

            • You must choose a default method for calculating traffic, either Live traffic or Typical traffic.

            • Time Offset—Choose a default value for the time offset drop-down menu. All will be available as choices at run time. Users can offset live traffic conditions by up to 12 hours from the current time, in 15-minute increments. For typical traffic, users can select a day of the week and time.

    • Infographics—Click Select an infographic to open the Select an infographic panel, where you can choose an infographic template from one of the following lists:

      • Esri Infographics—Ready-to-use templates from Esri.
      • Gallery Infographics—Additional ready-to-use templates from Esri. Only available for some locations.
      • Shared Infographics—Templates created in ArcGIS Business Analyst Web App and shared with you or your organization.
      • My Infographics—Templates created by you in ArcGIS Business Analyst Web App.

• Infographic settings—Customize the widget's appearance and tools.

  • View mode—Choose from five arrangement styles for the infographic elements. The default style is Auto, which is responsive to different screen sizes. If you resize the widget in the builder with Auto mode selected, the arrangement updates to best fit the current dimensions.

  • Background color—Change the background color.

  • Run on map click—Allow users to run the infographic for a specific location by clicking that location on a connected Map widget. Users can click existing point and polygon features, or click anywhere on the basemap to drop a pin. This setting is only applicable to Preset mode.

  • Display Header—Display a header at the top of the widget.

    • Header color—Change the header color.
    • Header text color—Change the header text color.

  • Image export—Allow users to export the infographic as a .png file.

  • Dynamic HTML export—Allow users to export the infographic to HTML.

  • Excel export—Allow users to export the infographic as a Microsoft Excel file.

  • PDF export—Allow users to export the infographic as a PDF.

  • Fullscreen—Include the Fullscreen button in the widget's header. This setting is only applicable to Preset mode.

  • Allow zoom—Include the zoom option in the widget's header. This option is not available for the Slides view mode.

• GeoEnrichment—Add a GeoEnrichment utility service. This setting is optional. The widget automatically uses the default GeoEnrichment utility service that corresponds to the specified organization level. You can use this setting if you want to specify another GeoEnrichment utility service. If you select the default GeoEnrichment service, when you publish the app, you are prompted to authorize access to GeoEnrichment with your subscription, which allows public users or members of your organization without the required privileges to use the widget.

  If you publish the app without authorizing access to GeoEnrichment with your subscription, all users are prompted to sign in to an account with the required privileges.

  Add a custom GeoEnrichment utility service by URL

Interaction options

You can configure message actions to have the Business Analyst widget interact with other widgets. For example, you can allow users to select point and polygon features from a Map widget and run infographics for those features. To do this, add the Record selection changes trigger on the Action tab of the Map widget's settings, select the Business Analyst widget as the target, and add the Select feature action. Using the same trigger, you can also configure the Select feature action in the List, Table, Search, and Query widgets' settings.

In Workflow mode, when a feature or record is selected in a supported widget, the Business Analyst widget lists the feature. In Preset mode, when a feature or record is selected in a supported widget, the Business Analyst widget automatically updates the preset infographic based on the selection.