IA Report Builder 2.3.0 – 4 April 2022 Release Notes

Overview

The main goal of Report Builder version 2.3.0 is the upgrade to the charting library (used for the chart widgets) to the latest available version. This is largely a behind-the-scenes change, although you may notice some very subtle differences to the look and feel of the charts. Besides improving performance and adding functionality, this enabled a number of chart-related feature requests and bug fixes. Version 2.3.0 also includes several non-chart related improvements and bug fixes, as well as changes to support new behaviour in the latest update to ArcGIS Online.

New features

Ability to remove chart axis lines without removing axis labels

We have introduced two advanced settings to cartesian charts called X Axis – Show Border? and Y Axis – Show Border? which allows for a chart like this (no Y-axis line):

Ability to show comparison bars in bar charts on the far right

Values for comparison areas are now always displayed to the right of any bar for core layer feature(s) and are not included in the sorting of the other bars.

Ability to insert the value for the current date and the current date

You can now use the #TODAY variable in a Text or Text Box widget to display indicator values for the current year. This is useful for indicators where the latest date might be different from the current date e.g. population projections.

The #TODAY variable picks up todays’ date and returns it using the specified format:

#TODAY{yyyy} = '2022'
#TODAY{mm} = '03'
#TODAY{mmm} = 'Mar'

As this is the 1st variable to be processed you can use inside the #IVALUE variable using this syntax: 

#IVALUE{<id>,1,#TODAY{yyyy}}

Here is an example:

#INAME{catalog:I25097}, #TODAY{yyyy} = #IVALUE{catalog:I25097, 1, #TODAY{yyyy}}

This would result in the following text:

2018-based projected population, persons aged 0-4, 2022 = 13,314

Further information can be found in the Variables help page.

Export icon tooltips added

A tooltip has been added to the export icons of charts and tables.

Ability to add line breaks to tooltips

You can use \n to add a line break into a chart tooltip. This is especially useful for smaller chart widgets where the tooltip would otherwise be cut off.

Disable widget double-click edit

By default, double-clicking on a widget in a report will open the Data & Settings dialog, or in the case of a Text or Text Box Widget, the text editor. While double-clicking on a Text or Text Box Widget, it is possible to accidentally click the Cut button in the widget toolbar and remove the widget from the report, particularly if the text widget only contains one line of text. If you are finding this a problem, you can disable the double-click action for widgets. You can do this by clicking the ellipsis in the top right corner of Report Builder and toggling the Double-click to Edit setting.

Changes in Pie Chart legend layout

The update to the latest charting library meant that we had to make minor changes to the layout and position of Pie Chart legends. If you are using Pie Charts in your reports, especially if these are smaller widgets, you should check that all legend categories are still visible. If not, please adjust the size of the widget slightly until the full legend is displayed.

Key bug fixes

Chart widgets

  • Cartesian charts: axis colour is overwritten by grid line colour
  • Bar charts: bars sit on top of X-axis, causing axis line to only be visible between the bars
  • Pyramid Chart: palette colour is only applied to left side of chart
  • Report Builder crashes if you set a pyramid chart to Constrain Palette Colours = True and have only one colour defined in the Palette
  • Population pyramid with aggregated data – data label left/right settings get overridden
  • Scatterplot widget: default point size is too small

Text / Text Box Widgets

  • When highlighting the default text to delete it, the text editor closes if the mouse pointer is moved outside of text box
  • Inserting an icon doesn’t allow the icon to be selected (to delete it or change size or colour) and doesn’t allow for text to be added after the icon
  • Text not showing in Edit Text/Rules popup (the first time you edit it)

Other bug fixes

  • Report Builder doesn’t support nested/grouped layers in web maps built with the new ArcGIS Online map viewer
  • First page is blank if you print a report using Firefox
  • Groups on Report Builder home page are not displayed in alphabetical order
  • Time Series Table: table breaks if the indicators have different dates available
  • Long delay for a table widget to show when added to a report
  • “Save As” on existing report creates an AGOL item with an incorrect URL
  • Page order dialog crashes when report contains a large number of web map widgets

 

We hope you will enjoy this new release of Report Builder!

If you have any questions relating to this release please contact support@instantatlas.com.

IA Report Builder 2.2.0 – 15 October 2021 Release Notes

Overview

Report Builder version 2.2.0 fixes a number of bugs and also introduces functionality (beta) to import or link to other reports.

Bug fixes

  • Case sensitivity issue with feature ID field
  • Stacked bar chart with look-down comparison areas shhowing incorrect colours
  • Web map widget – visible layers not acting on raster layers
  • Text widget stripping text following a number (improvement to number formatting)
  • Editing table widget indicator aliases breaks widget height
  • Icon Chart widget height behaviour
  • “Fill to” settings missing from Icon Chart widget
  • Toggler widget not working on a phone screen
  • Report toolbar display issues on a phone screen
  • Commas missing between list of area names (#FNAMES) for aggregated reports

Importing/linking to other reports

It is now possible, for any page in a report, to specify another Report Builder report to import or to link to. This means that one report can be built from others, and that if linking is used, that any changes made to linked reports will automatically feed through to the parent report. This opens the door for a different approach to building and managing reports.

Note that this is beta functionality and we welcome any feedback on how we have implemented this in Report Builder. We created a help page and will be adding further information and examples to this.

To access the option to import or link, edit your report and click Pages > Current Page > Import or Link.

Report Builder option to import or link a report

You will be asked for browse in your ArcGIS Online organisation for a report design to import/link.

Report Builder choose report design option

We hope you will enjoy using this new functionality!

If you have any questions relating to this release please contact support@instantatlas.com.

IA Report Builder 2.1.0 – 19 July 2021 Release Notes

Overview

Report Builder version 2.1.0 introduces a new widget, the Toggle Content widget. This has been added in order to enable content sections in a report to be expanded/collapsed by the end user. Prior to the addition of this widget, the same “accordion” effect had to be achieved using styling in the website that the report was embedded into.

Toggle Content Widget

In the example below, the end user can click the button next to the Safeguarding heading to collapse the content below it (this is just an image, the toggle won’t do anything here!).

InstantAtlas Report Builder Toggle Content Widget

The different settings available for this widget are described on the widget help page.

Number Formatting

It is now possible to specify a percentage number format (P) for your widget to show data as percentages. For example, for a Data Table widget, locate the Number Format setting under Numbers & Values and replace this with P. For a Bar Chart widget, locate the Axis Label Format setting under Axes and type in P. Visit this page for more on the number formats supported in Report Builder.

If you have any questions relating to this release please contact support@instantatlas.com.

IA Report Builder 2.0.2 – 14 June 2021 Release Notes

Overview

Report Builder version 2.0.2 addresses a number of bugs, several of which will  ensure a smoother migration from version 1 to version 2 reports. We have also added some of the functionality of Report Builder 1 that had not yet been implemented in version 2, as well as performance, accessibility and error handling improvements.

Bug fixes

  • Bar Charts set to horizontal orientation now also work when the selected data contains upper and lower confidence limits.
  • The Scatter/Bubble Chart widget has gained the setting X Axis Range which allows the x-axis to be constrained between two defined values.
  • The Scatter/Bubble Chart widget can now be configured to show all points in the same colour without having to define a separate colour for each feature. This is done by switching Constrain Palette Colors on:
  • The Filled Icon widget now shows the icon filled in the selected Highlight Color if Highlight Selected Feature is enabled.
  • Copying widgets from one report to another now works more reliably. In version 2.0.1 and when copying multiple widgets in succession, a browser refresh was required between pasting different widgets.
  • In the Edit Chart Colors… dialog (main menu – StylingChart Colors) the Toggle direct edit buttons now work by providing a text field to insert colour values in hexadecimal or RBG format.
  • Exiting a report now takes the user back to the same folder view with the same sorting retained.
  • Fix for an issue with hash/anchor links that occurred when using the # symbol in the browser address bar . This allows users e.g. to jump to a particular section of a report by providing the URL to the anchor tag.
  • Fix for certain font families (those containing spaces in the name) not being applied in view mode of a report.

Improved migration

  • Pie Charts in migrated reports no longer group small segments together into one category.
  • Titles of Table widgets are now migrated correctly.
  • The content of the Table Footer settings from Report Builder 1 is now migrated to the setting Caption in Report Builder 2.
    Please note: Any tables in reports that have been migrated and saved before the release of Report Builder version 2.0.2 will have lost the Table Footer text. You can re-add the text by entering it into the Caption setting manually. Alternatively, if the equivalent version 1 report still exists, you can migrate it again.

Additional functionality

  • It is now possible to change the font colour of text in a Text widget through the editor toolbar. You have the option to choose one of the predefined colours or use the palette icon to open the Color Picker dialog
  • The Advanced Settings dialog in the Pages menu has gained options to customise the index page of the report.
  • Any changes to the Pages|Advanced Settings dialog now turns the Save button of the report editor orange, indicating that there are unsaved changes.
  • Line and scatterplot widget point styles have been extended and some of the less obvious options have been subtly renamed.
  • Web accessibility has been improved by adding the option to show unique point markers in chart series lines and index options to chart labels – please see this blog post to find out more about accessibility for reports created using Report Builder. 
  • The Data Catalog data model is cached in the browser whilst the editor page is open, which means the widget settings dialog opens faster.
  • Improved error messaging when/if connections fail.
  • Widgets have become more robust to temporary data connection errors. If a connection fails, the widget will attempt to reconnect to the data after a few seconds, up to 3 times before giving up.

If you have any questions relating to this release or migration of reports from version 1 to version 2 please contact support@instantatlas.com.

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 factsheets to complex, multi-page area profiles. To embed a report, add this code to your web page:


<div id="iaReportHolder" class="ia-app ia-embedded-report"><script src="https://reports.instantatlas.com/static/js/ia-reports.js?report=5db1ef44afe64e499b390b57c0f012ae&container=iaReportHolder&auto=true"></script></div>

Simply change app ID (shown above in red) to embed a different report. If you wish to embed a report for a particular feature rather than the index page, add this code to your web page:


<div id="iaReportHolder" class="ia-app ia-embedded-report"><script src="https://reports.instantatlas.com/static/js/ia-reports.js?report=5db1ef44afe64e499b390b57c0f012ae&feature=E05007163&container=iaReportHolder&auto=true"></script></div>

Simply change the feature code (shown above in blue) to embed the report for a different feature. If the report contains a Navigator widget, this can then be used to switch the area being shown (you may need to edit the widget’s Item Hyperlink setting).

To embed multiple reports in the same page (along with drop-down controls to select the report) you need to use a configuration attribute as shown below.

<div> <div class="ia-report-viewer ia-app ia-embedded-report no-controls" data-config='{"reports": [{"id": "677880328fb94104b91b758bd498d881", "name": "County"}, {"id": "ce13e3808baa4e56aad1b5583a9244bd", "name": "Local Authority"}, {"id": "2a41ba53aebc43198723a4705f706223", "name": "Active Partnership"}, {"id": "692664a5ea1c469a8a263cff0d3868fc", "name": "Local Delivery Pilot Area"}], "default_geography": "677880328fb94104b91b758bd498d881"}'> <script type="text/javascript" defer src="https://reports.instantatlas.com/static/js/ia-reports.js?container=.ia-report-viewer&auto=true"></script> </div> </div>

The red text shows the script tag that does the work of embedding the report(s). Note the ?container=.ia-report-viewer part of the URL – this is what tells the script where to fetch the configuration from. You will need to make sure that the “class” of your enclosing <div> matches this ?container= instruction.

The blue text shows the reports configuration. This is encoded as JSON and can look a bit complicated – but is essentially a list of the reports that you want to use as { "id": "<report-id>", "name": "<label-to-show-in-drop-down>" }.

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.