Register the Geocortex Reporting Custom Widgets

The ability to host and run reports in Web AppBuilder apps is provided by custom widgets that were developed by Geocortex for this purpose.

There are two widgets:

If you want to use Web AppBuilder apps to host reports, you must first register the widgets. You only need to register the widgets one time, and then you can use them in as many apps as you want.

Geocortex Reporting supports two editions of Web AppBuilder. Which edition you use depends on whether you are using on-premises Reporting or cloud Reporting:

You cannot use the ArcGIS Online edition of Web AppBuilder to host reports, because ArcGIS Online does not support custom widgets.

Register the Widgets with Web AppBuilder in Portal for ArcGIS

This registration procedure applies to on-premises installations of Geocortex Reporting only.

To register the Reporting widgets with Web AppBuilder in Portal for ArcGIS:

  1. Sign in to your ArcGIS portal and open the Content page.

  2. 2D Widget: Add an item for the 2D widget:

    1. Add an application: In My Content, click Add Item and select An application.

    2. Set the Type to Application Extension (AppBuilder).

    3. Specify the URL to the 2D widget's manifest.json file.

      You can either use your on-premises copy of the manifest.json file or, if your portal has Internet access, the copy in the cloud:

      • On-Premises Manifest: Locate the manifest.json file in your Geocortex Reporting deployment and enter its URL in the Manifest URL box.

        If you used the default IIS settings in the Geocortex Reporting Post Installer, then the URL will look something like this:

        [http]://[host.mydomain.com]/geocortex/reporting/wab/widgets/2d/reporting/manifest.json

        Use the correct protocol, HTTP or HTTPS, and replace [host.mydomain.com] with your host name.

      • Cloud Manifest: Paste the following URL in the Manifest URL box:

        https://apps.geocortex.com/reporting/wab/widgets/2d/reporting/manifest.json

    4. Click away from the Manifest URL box to retrieve the Title from the manifest.json file.

      You can change the title if you want.

    5. Add one or more tags for the item, for example, Geocortex, Reporting, and widget.

    6. Click Add Item.

      The 2D Reporting widget is now registered with your portal.

  3. 3D Widget: If your organization uses 3D Web AppBuilder apps, add an item for the 3D widget:

    1. Add an application: in My Content, click Add Item and select An application.

    2. Set the Type to Application Extension (AppBuilder).

    3. Specify the URL to the 3D widget's manifest.json file.

      You can either use your on-premises copy of the manifest.json file or, if your portal has Internet access, the copy in the cloud:

      • On-Premises Manifest: Locate the manifest.json file in your Geocortex Reporting deployment and enter its URL in the Manifest URL box.

        If you used the default IIS settings in the Geocortex Reporting Post Installer, then the URL will look something like this:

        [http]://[host.mydomain.com]/geocortex/reporting/wab/widgets/3d/reporting/manifest.json

        Use the correct protocol, HTTP or HTTPS, and replace [host.mydomain.com] with your host name.

      • Cloud Manifest: Paste the following URL in the Manifest URL box:

        https://apps.geocortex.com/reporting/wab/widgets/3d/reporting/manifest.json

    4. Click away from the Manifest URL box to retrieve the Title from the manifest.json file.

      You can change the title if you want.

    5. Add one or more tags for the item, for example, Geocortex, Reporting, and widget.

    6. Click Add Item.

      The 3D Reporting widget is now registered with your portal.

  4. Portal for ArcGIS 10.5.1 Only: If you are using version 10.5.1 of Portal for ArcGIS, you must modify your Portal installation to support the Reporting widgets. To do this, you will copy some files from Web AppBuilder (Developer Edition) 2.4 to Web AppBuilder in your Portal for ArcGIS installation, as follows:

    1. Sign in to ArcGIS for Developers.

      If you don't have an ArcGIS for Developers account, you can get a free account here.

    2. Download Web AppBuilder (Developer Edition) 2.4.

    3. Extract the contents of the archive.

    4. Locate the jimu.js folder in Web AppBuilder (Developer Edition).

      The folder is here:

      WebAppBuilderForArcGIS\client\stemapp\jimu.js

    5. Open a second File Explorer window and locate the jimu.js folder in your Portal for ArcGIS installation.

      If Portal for ArcGIS is installed at the default location, the folder is here:

      C:\Program Files\ArcGIS\Portal\Apps\webappbuilder\stemapp\jimu.js

    6. Copy the LayerInfos folder and all the files from the jimu.js folder in Developer Edition to the jimu.js folder in Portal for ArcGIS.

    7. When prompted, overwrite the existing files.

      The main.js and oauth-callback.html files will be overwritten.

    8. Clear your browser's cache.

      The next time you open or reload Web AppBuilder in Portal for ArcGIS, you will be able to access the Reporting widget from an app's Widgets panel (Widget | Set the widgets in this controller | Custom | Reporting). In 2D apps, you can access the 2D widget. In 3D apps, you can access the 3D widget.

Deploy the Widgets to Web AppBuilder (Developer Edition)

This deployment procedure assumes that you have already installed Web AppBuilder (Developer Edition). You can download Web AppBuilder (Developer Edition) here for free. Follow the instructions to install it.

To deploy the Reporting widgets to Web AppBuilder (Developer Edition):

  1. Locate the root of your Web AppBuilder (Developer Edition) installation.

    By default, the root is called WebAppBuilderForArcGIS.

  2. If you have not yet downloaded the Geocortex Reporting widgets, download them now.

  3. Extract the files and locate the widgets folder.

    The widgets folder has two subfolders called 2D and 3D.

  4. Copy the downloaded \widgets\2D\Reporting folder to Web AppBuilder's \[root]\client\stemapp\widgets folder.

  5. Copy the downloaded \widgets\3D\Reporting folder to Web AppBuilder's \[root]\client\stemapp3d\widgets folder.

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.2