MapApp limitations

These MapApp properties are not supported with the OMI web client:

• Browser Stylesheet

• Event Handler Available Events

In addition, the Sources property supports only string constants, not reference values.

Defining a reverse proxy for the MapApp

Any map source that needs a key or credential to be used with the MapApp must use a reverse proxy to connect to the OMI web client. Configuring this for the MapApp requires updates to a settings file on the WinPlatform that hosts the WebViewEngine. You must also be sure to enter the correct information when configuring the MapApp in its layout pane.

Important! Only these map sources require a credential or key: Google, Bing, and sometimes ArcGis, Baidu, XYZ, and WMS. You do not need to perform these steps for other map sources.

The general procedure for configuring any map source to use a reverse proxy is:

1. Enter the necessary information in the source Properties fields when configuring the MapApp in its layout pane.

2. On the platform that hosts the WebViewEngine, edit the C:\Program Files (x86)\Common Files\ArchestrA\Services\proxyserver\appsettings.json file:

   1. In the Routes section for the map source, find and uncomment the section for your map source.

   2. In the uncommented section, set the correct Path, PathRemovePrefix, and Append values for the map source.

   3. In the Clusters section for the map source, enter the URL for the map source.

3. Clear the browser cache on the WebViewEngine after making the changes to appsettings.json.

The sections below describe the specific changes for each type of map source.

Google Maps

Properties fields: Enter the API key.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first Google map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/google/1/1{**catch-all}"

  "PathRemovePrefix": "/Map/google/1"

• Append: Enter your Google API key as the value.

Clusters section of appsettings.json: The Address value should already be the URL for the Google map. Correct it if it is not.

Bing Maps

Properties fields: Enter the API key.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first Bing map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/Bing/1{**catch-all}"

  "PathRemovePrefix": "/Map/Bing/1"

• Append: Enter your Bing API key as the value.

Clusters section of appsettings.json: The Address value should already be the URL for the Bing map. Correct it if it is not.

XYZ Maps

Properties fields: Enter the source URL. If there is no key parameter in the URL, this map does not need a reverse proxy, and you do not have to make any changes to appsettings.json. If there is a key parameter, make the changes below.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first XYZ map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/XYZ/1{**catch-all}"

  "PathRemovePrefix": "/Map/XYZ/1"

• Append: Enter your XYZ API key as the value.

Clusters section of appsettings.json: The Address value should already be the URL for the XYZ map. Correct it if it is not.

WMS Maps

Properties fields: Enter the source URL. If the URL does not require a credential, this map does not need a reverse proxy, and you do not have to make any changes to appsettings.json. If it does need a credential, make the changes below.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first WMS map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/WMS/1{**catch-all}"

  "PathRemovePrefix": "/Map/WMS/1"

• Append: Set the Basic value to the Base64String encoded username:password for the map URL.

Clusters section of appsettings.json: Set the Address value to the URL for your map server.

Baidu Maps

Properties fields: Enter the source URL. If there is no ak parameter in the URL, this map does not need a reverse proxy, and you do not have to make any changes to appsettings.json. If there is an ak parameter, Make the changes below.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first Baidu map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/Baidu/1{**catch-all}"

  "PathRemovePrefix": "/Map/Baidu/1"

• Append: Enter your Baidu key as the value.

Clusters section of appsettings.json: The Address value should already be the URL for the Baidu map. Correct it if it is not.

ArcGis Maps

Properties fields: Enter the source URL. If the URL does not require a credential, this map does not need a reverse proxy, and you do not have to make any changes to appsettings.json. If it does need a credential, make the changes below.

Routes section of appsettings.json:

• Path and PathRemovePrefix: Enter 1 for the first ArcGis map. If there is another map configured in the editor, enter 2. For example:

  "path":"/Map/arcgis/1{**catch-all}"

  "PathRemovePrefix": "/Map/arcgis/1"

• Append: For ArcGis versions before 10.9, set the Basic value to your ArcGis token. For older versions of ArcGis, set the Append value to Bearer followed by your ArcGis token.

Clusters section of appsettings.json: Set the Address value to the URL for your map server.