This article contains the following sections:

This section covers how to deploy the Oblique Viewer for Nearmap Widget, including configuring for use.

Oblique Viewer for Nearmap is a custom ArcGIS widget, which means it is not a widget that Esri provides. An administrator needs to install it in one of two ways:

  • Bringing the widget into Portal (ArcGIS Enterprise).
    This is the recommended method, and the one that is covered in this article.

  • Bringing the custom code into Web AppBuilder and hosting it (along with any other ArcGIS widgets).


Before you read these instructions, you may prefer to follow the instructional webinar which takes you through the steps of installing and configuring the widget in ArcGIS Portal.



Creating Oblique Viewer for Nearmap Widget Application in ArcGIS Portal/Enterprise (recommended)

The ArcGIS portal is the preferred option for deploying the Nearmap Oblique Viewer widget.

You can add custom widgets when you create Web AppBuilder applications. Before you can use a custom widget, it must be hosted on a web server and registered to your portal. These are the steps to set this up:

What you need:

You will only need to follow these steps when installing and configuring the widget for the first time, or whenever there is an upgrade to the widget.


Step 1: Install widget onto http server

Install on the same server as your portal. This is the easiest and most secure option.

  1. Remote desktop into your portal server.
  2. Download the Oblique Viewer for Nearmap Widget source code fromhttps://www.arcgis.com/home/item.html?id=3c978542cfde46e3a8e9d9e9b32c7937#
  3. In your file explorer, create a folder at the root directory of your server path. In the example below, we called it "widgets".
    For example, https://servername/widgets/ is C:\inetpub\wwwroot\widgets\
  4. Unzip the NearmapObliqueViewer.zip into that folder.



  5. Test the installation by pasting the manifest.json file path into your browser. You should see the file's contents.


Step 2: Register widget on ArcGIS Portal

  1. Log into ArcGIS Enterprise.
  2. Select Content My Content.
  3. Select Add Item → An application
  4. Check the Application Extension (AppBuilder) radio button
  5. Paste the manifest.json URL that you used to test the installation in the previous step.
    For example: C:\inetpub\wwwroot\widgets\NearmapObliqueViewer\manifest.json (file path on the server) becomes https://servername/widgets/NearmapObliqueViewer/manifest.json
  6. Enter a title for the widget. This will be the name your users see when they select the widget.
  7. Enter labels then press Add Item.

Esri has provided steps in detail to add custom widgets for the whole organization. Here is the link to ArcGIS Enterprise documentation article:

https://enterprise.arcgis.com/en/portal/latest/use/add-custom-widgets.htm

You can now create a Web AppBuilder application within ArcGIS Portal.



Creating a Web AppBuilder application using the Oblique Viewer for Nearmap widget

What you need:

  • 'Creator' access to ArcGIS Online
  • A Nearmap API key (This article explains how to retrieve your API key: API Key Authentication.)
  1. From within ArcGIS Portal, navigate to Content > Create > App > Using WebApp Builder, press Create New and press Next.

  2. Enter your widget title (this is the name you entered when you registered the widget) and press OK.

  3. Click on the Widget tab and then press the left-most grey square down the bottom – this is the first available widget space.


  4. Click the Custom tab then select Nearmap Oblique Viewer from the array of widgets and press OK.


  5. Enter your Nearmap API key and press OK.
    Find out how to get your API key here: API Key Authentication.
    There is more information about the API setting in the following section. See Nearmap API Key.


You can now follow the steps to configure the widget as you would like it to be used by your organisation.

Configuring the Widget

Once the widget has been added to your organisation's ArcGIS platform, as administrator you can change some of the default settings to better customise the widget for your organisation's needs.


This widget can be set to open automatically when an app starts. Click the Do not open this widget when the app starts button Do not open this widget when the app starts on the widget to turn on the option to open the widget automatically. (For widgets you need to add to the app first, you can make this setting after configuring the widget.)

  1. Hover over the widget and click on the pencil icon to bring up the widget settings Configure this widget.



    You see the configuration window for the widget.

  2. When you are finished configuring, press OK.


The table below describes the settings and the effect each has in the widget.


Setting NameSetting descriptionEffect of setting in the widget

Widget name

By default “Oblique Viewer for Nearmap” is displayed in the textbox at the top of the screen. Widgets must have a name.
While administrators can specify any name, we recommended keeping the default.



Once saved and on reload of the configuration, the title of the configuration screen will display updated widget name as “Configure Oblique Viewer for Nearmap”.



Widget icon

To change the widget icon, click the Change widget icon button and upload an image file in gif, jpg, jpeg, or png format.


Nearmap API Key

You must have an API key in this field and it must be a valid Nearmap API key. The key you enter here will be used when the user tries to use the Nearmap Oblique Viewer widget.

When you try to save the widget settings, the specified text will be validated against the Nearmap servers. If the validation fails, the textbox will be highlighted red and you will see the message: “The value entered is not valid”. 

For more information on Nearmap API keys, follow the link: https://docs.nearmap.com/display/ND/Managing+API+Keys. The same link is also provided in the hint text for the parameter. 


Note: Based on the internet connection and server availability, it may take some time to verify the specified key. Until the verification results are received, a loading indicator will be displayed on the extreme right of the text box.


Location symbol

Click thesymbol to select from a wide collection of categorised shapes. 

Location symbol shows the clicked location on the map in the widget.



Photo extent symbol

Click thesymbol to select any area symbol from the various combination of fill colour and outline colour, along with transparency and other related settings.

The extent symbol is used to mark the extent of the oblique image on the map in the widget.


Measurement line symbol

The Measurement line symbol sets the colour and thickness of any vertical or horizontal measuring line that users add to the oblique image using the widget.


Default measurement units

The Default measurement units determine the units displayed against countermeasure lines.

Feet are displayed by default but from the dropdown you can select Meters, Kilometers, Miles, Yards and Nautical Miles.


Text labels

You can configure font colour and size of text labels that users add with the widget.

Font size cannot be less than 1.

In the widget, the text will be surrounded by a white colour halo (not configurable) to add the contrast to the text.