Tips for using Report Builder 2.0

A major new version of InstantAtlas Report Builder (version 2.0) is now available. Report Builder 2.0 is a complete redesign and rebuild of the application, keeping all that was good from version 1 whilst making the reports faster to load, easier to create, more responsive to different devices and more accessible to a range of users.

The process of building a report and editing widgets is essentially the same as in Report Builder 1. It was important to us that that existing users did not have to learn how to create reports all over again! However, there are a few notable differences within the Editor user interface that we thought we would point out  to make switching to using Report Builder 2 a little easier.

Saved report location

When you create a new report in 2.0, this will automatically be saved either in the root of your ArcGIS Online account, or if you selected a folder on the Report Builder homepage before creating your report, in that folder. You can always move this to a different folder if you need to using the ‘Move’ option in ArcGIS Online.

Context menu

We no longer override the browser’s context menu when right-click with your mouse on a report page in the Report Builder workspace. You can access the same functionality in other ways, either from the top menus, or in the case of pasting a widget, using the ‘jigsaw bar’ at the foot of the page or by selecting an existing widget on the page and clicking the page button that appears in the widget toolbar.

Setting Comparison Areas for a widget

This is now done from the Settings tab of the widget Data & Settings window – in Report Builder 1 it was done under the Data tab.

Setting a widget to show data for all areas

This is now done from the Settings tab of the widget Data & Settings window (usually in the Behaviour settings group which becomes visible when the advanced settings are toggled on) – in Report Builder 1 it was done under the Data tab.

Publishing reports as a bundle of static files

This was an option in Report Builder 1 option but has been dropped. It is unnecessary due to the way the reports load in Report Builder 2. It is entirely possible to use reports ‘live’ so that they always show the latest data in the report data source(s), and so that you do not have to publish them as static files each time the source data is updated.

Report navigation toolbar

By default, reports now show a toolbar at the top. This allows the user to switch page, print and return to the report index page with the list of features to select from. This toolbar can be hidden if necessary by clicking the Pages menu > Advanced.

How to embed InstantAtlas apps into your website

The purpose of this post is to provide the necessary information for embedding InstantAtlas apps into a website. Colour is used to explain the code below – if you have difficulty distinguishing the colours used please contact support@instantatlas.com and we will find an alternative. The actual creation of the apps in the first place is not covered in this post.

Reports

InstantAtlas Report Builder is a tool for for designing and publishing any type of report on ArcGIS Online from simple snapshots to complex, multi-page area profiles. The reports created using Report Builder can be embedded using two methods: static or dynamic. In the first case, the report must first be published as a bundle of static HTML files – this can be done within Report Builder by the author of the report. We recommend using the static embedding method to ensure the report pages load as quickly as possible.

Static method

Add this code to a web page to embed a report that has been published as static HTML files:


<div>
        <div id="iaoReportContainer" class="iao-content report-container" data-config='{"reports": [{"id": "5db1ef44afe64e499b390b57c0f012ae", "name": "Ward"}], "default_geography":"5db1ef44afe64e499b390b57c0f012ae", "urlMode": "query", "controls": { "type": "drop-down", "container": ".iao-report-controls", "reportLabel": "Select a report", "featureLabel": "Select an area"}}'>
            <script type="text/javascript" defer src="https://reports.instantatlas.com/scripts/lib/IAO.embed.min.js?container=iaoReportContainer&auto=true"></script>
        </div>
    </div>

You can change the following elements:

  • 5db1ef44afe64e499b390b57c0f012ae – this is the app ID (from ArcGIS Online) of the report you wish to embed.
  • Ward – this is the label for the report that will be displayed in the “Select a Report” drop down menu.
  • Select a report and Select an area – these are the labels for the drop down menus that will be shown above the report.

You can embed multiple reports in the following way:


<div>
        <div id="iaoReportContainer" class="iao-content report-container" data-config='{"reports": [{"id": "5db1ef44afe64e499b390b57c0f012ae", "name": "Ward"},{"id": "0647c83c53f24789b8d637c0ad6578c0", "name": "LSOA"}], "default_geography":"5db1ef44afe64e499b390b57c0f012ae", "urlMode": "query", "controls": { "type": "drop-down", "container": ".iao-report-controls", "reportLabel": "Select a report", "featureLabel": "Select an area"}}'>
            <script type="text/javascript" defer src="https://reports.instantatlas.com/scripts/lib/IAO.embed.min.js?container=iaoReportContainer&auto=true"></script>
        </div>
    </div>

The app ID and name of each additional report should simply be added as shown above in red. The report that shows by default is defined by the app ID shown above in green.

Note: for the report embedding to work, jQuery must be loaded before the report. A defer setting has been used in the embed code to make sure the report loads last.

An example of embedding reports using this method can be seen in this page of the Suffolk Observatory.

Dynamic method

Add this code to a web page to embed a report using the dynamic method.


<div id="iaoReportContainer" class="iao-content" style="width: 1000px;height: 2751px;"><script type="text/javascript" src="https://reports.instantatlas.com/embed/5db1ef44afe64e499b390b57c0f012ae/E05007163?container=iaoReportContainer"></script></div>

Simply change app ID (shown above in red) to embed a different report and optionally the feature code (shown above in blue) to load the report for a different feature.

Data Explorer

InstantAtlas Data explorer connects directly to an InstantAtlas Data Catalog in ArcGIS Online and allow your web site users to browse and download data and create graphics for documents and presentations.

Add this code to a web page to embed a data explorer app.


<link href="https://hub.instantatlas.com/data-catalog-explorer/static/css/main.css" rel="stylesheet">
<div id="root"></div>
<script src="https://hub.instantatlas.com/data-catalog-explorer/static/js/main.js"></script>
<script>window.dataCatalogExplorer.launch({ "appid": "e3d83edc76bd45548ddd0e2ee4fe4bdf", "container": "root" })</script>‎

e3d83edc76bd45548ddd0e2ee4fe4bdf – this is the app ID (from ArcGIS Online) of the data explorer app you wish to embed.

An example of embedding a data explorer app can be seen on this page of the Suffolk Observatory.

Map Explorer

The Map Explorer app is a simple-to-use app that that allows a user to select from a pre-defined set of indicators from an InstantAtlas Data Catalog and visualize them as thematic maps.


<div id="ia-map-panel" style="width: 100%; min-height: 500px; height: calc(100vh - 300px);">
<script src="https://hub.instantatlas.com/map-explorer/embed?c=ia-map-panel&appid=917b1891e5934d6baeeff23cdb0e9f38"></script>
</div>

917b1891e5934d6baeeff23cdb0e9f38 – this is the app ID (from ArcGIS Online) of the map explorer app you wish to embed.

Custom Area Reporter

The InstantAtlas Custom Area Reporter allows users to define their own areas and generate reports for them. Users select areas from a map using a range of selection tools. Once an area is defined users can produce one or more reports for the area. The report presents aggregated figures for the chosen area based on the underlying geography.

Add this code to a web page to embed a custom area reporter app.


<div>
        <div id="report-content-panel" style="width: 100%; height: 100%; border: 1px solid #ccc; position: relative;">
            <script type="text/javascript" defer src="https://reports.instantatlas.com/embed-selector?appid=1a451d1bbe3544849585ab2745c25f5d&container=report-content-panel&flush=true"></script>
        </div>‎
    </div>
    <script src="https://js.arcgis.com/3.24/"></script>‎

1a451d1bbe3544849585ab2745c25f5d – this is the app ID (from ArcGIS Online) of the custom area reporter app you wish to embed.

An example of embedding a custom area reporter app can be seen on this page of the Suffolk Observatory.

Support

If you have any difficulties embedding InstantAtlas apps in a website please contact support@instantatlas.com.

Announcing InstantAtlas Report Builder+

Starting today (6th February 2019) if you are an existing customer you may notice some differences in Report Builder and Dashboard Builder. We have reorganised our products in the ArcGIS Marketplace to streamline and improve both your experience and our workflow. So from now, Dashboard Builder and Report Builder have been merged into a single product, InstantAtlas Report Builder+. If you have previously purchased a licence for either Dashboard Builder or Report Builder you can upgrade to the new Report Builder+ and next time you sign in we will ask if you want to do just that. Continue reading Announcing InstantAtlas Report Builder+