Register the Geocortex Printing Custom Widgets

The ability to host and run print templates 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 print templates, 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 Printing supports three editions of Web AppBuilder. Which edition you use depends on whether you use on-premises Printing or cloud Printing:

Follow the instructions for the edition of Web AppBuilder you use:

Register the Widgets with Web AppBuilder in Portal for ArcGIS

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

After registering Geocortex Printing, you may want to modify the widgets so they do not access any resources on the Internet. See Point the Widgets to Local Resources.

To register the Printing 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 (App Builder).

    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 Printing deployment and enter its URL in the Manifest URL box.

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

        [http]://[host.mydomain.com]/geocortex/printing/wab/widgets/2d/printing/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/printing/wab/widgets/2d/printing/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, Printing, and widget.

    6. Click Add Item.

      The 2D Printing 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 Printing deployment and enter its URL in the Manifest URL box.

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

        [http]://[host.mydomain.com]/geocortex/printing/wab/widgets/3d/printing/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/printing/wab/widgets/3d/printing/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, Printing, and widget.

    6. Click Add Item.

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

  4. Portal for ArcGIS 10.5.1 Only: If you use version 10.5.1 of Portal for ArcGIS, you must modify your Portal installation to support the Printing 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 Printing widget from an app's Widgets panel (Widget | Set the widgets in this controller | Custom | Printing). In 2D apps, you can access the 2D widget. In 3D apps, you can access the 3D widget.

Point the Widgets to Local Resources

By default, the Printing widgets for Web AppBuilder in Portal for ArcGIS access files in the cloud. You can modify the widgets so they access local files only. This enables you to run Geocortex Printing in an environment that does not have or does not allow Internet access.

To point the widgets to local resources:

  1. Widget Files: Widgets access files in a folder called widget-files. The default URL for the widget-files folder is:

    https://apps.geocortex.com/printing/wab/widget-files

    You need to modify the URL to point to your on-premises Printing deployment, for example:

    https://host.mydomain.com/Geocortex/Printing/wab/widget-files

    Modify the widget-files URL in each of the following files:

    [installation-location]\Deployment\Wab\widgets\2D\Printing\setting\Setting.js

    [installation-location]\Deployment\Wab\widgets\2D\Printing\Widget.js

    [Installation-location] is the location where Geocortex Printing is installed. The default installation location is:

    C:\Program Files\Latitude Geographics\Geocortex Printing\

  2. Print Designer: By default, the widgets access Print Designer in the cloud:

    https://apps.geocortex.com/printing/designer/

    You need to modify the URL to point to your on-premises deployment of Print Designer, for example:

    https://host.mydomain.com/Geocortex/Printing/designer/

    Modify the Print Designer URL in the following file:

    [installation-location]\Deployment\Wab\widgets\2D\Printing\config.json

Register the Widget with Web AppBuilder for ArcGIS Online

A Geocortex Printing widget is available from the ArcGIS Marketplace. You can use this widget to run print templates from data inside your ArcGIS Online edition of Web AppBuilder.

This section explains how to deploy the hosted widget into a Web AppBuilder application and share it with Web AppBuilder authors and end users.

The following are important items to note before you begin: 

To register the Printing widget with Web AppBuilder for ArcGIS Online:

  1. Open ArcGIS Marketplace - Hosted Widgets and sign in with your Esri credentials.

  2. Click the Geocortex Printing widget.

    ArcGIS Marketplace - Hosted Widgets

  3. Click 60-Days Trial.

  4. Even if you already have a Geocortex license, select the 60-day trial option. Your trial is automatically converted to a subscription, so you can use the widget right away.

  5. Fill out the contact information and click Submit.

    A confirmation appears that your free trial is active.

  6. Sign in to the Console.

    The widget appears in the Apps & Data tab.

  7. Click Manage Sharing.

    ArcGIS Marketplace - Console

  8. Select the group of authors and end users you want to access the widget.

  9. Click OK.

    The steps differ slightly if you have already shared the widget and you want to edit the sharing group. In this instance, when you click Manage Sharing, you are directed to the Marketplace listing. Click Share. Ignore the message about insufficient permissions and click Edit group sharing. Make your changes and click Save.

    The Printing widget is now available in Web AppBuilder for the specified group of authors and end users.

    Web AppBuilder - Custom Widgets

See also...

YouTube Tech Tips video: Deploying the Hosted Widgets

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 Printing widgets to Web AppBuilder (Developer Edition):

  1. Download the widgets.

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

    By default, the root is called WebAppBuilderForArcGIS.

  3. Extract the files to the root.

    This places the widgets in the correct locations within your Web AppBuilder (Developer Edition) installation.

    The 2D widgets are in Web AppBuilder's \[root]\client\stemapp\widgets folder.

    The 3D widgets are in Web AppBuilder's \[root]\client\stemapp3d\widgets folder.