How to troubleshoot Embedded Map loading issues?

Problem Description

Embedded Map is a technology of embedding NetBrain map web page into a third party web page using iframe.

It is delivered as a JavaScript SDK for development usage.

There are many causes that could fail the embedded map loading if it is not configured properly.

This article describes a troubleshooting procedure to point out the requirements, restrictions, and resolutions.

Resolution

• Web Server Web.config file
  1. File location: %NetBrain%\Web Server\nb_publish_client\Web.config
  2. The following configuration must be added into the Web.config file for NetBrain to allow a third party web page to embed NetBrain map web page.

<configuration>

<httpProtocol>

<customHeaders>

<add name="Content-Security-Policy" value="frame-ancestors third_party_web_page_url"/>

</customHeaders>

</httpProtocol>

</configuration>

• Embed-Map-User
  1. For the Embedded Map to get authenticated and authorized from NetBrain when loading a map, an Embed-Map-User is needed. This user is restricted from login NetBrain main UI, but for Embedded Map use only.
  2. To validate the specified user is an Embed-Map-User, do the following steps.
     1. Login NetBrain System Management page with a system admin user.
     2. Navigate to User Accounts --> Users.
     3. Right-click on the expected user. If the user is an Embed-Map-User, there will be an option listed as "Set as Normal-User". Otherwise, the option will be "Set as Embed-Map-User".
• Web Server HTTPS enablement and certificate
  1. To embed a web page into an HTTPS-enabled web page, iframe requires the embedded web page must have HTTPS enabled as well for security purposes. In this case, as long as the third party web page has HTTPS enabled, NetBrain Web Server must enable HTTPS as well.
  2. With HTTPS enabled, for the third party web page to successfully load the embedded map, the certificate being used on NetBrain Web Server must be able to be authenticated from the client browser. When access NetBrain, if the browser displays a red lock icon in the address bar indicating the website is insecure, it means the certificate is not authenticated successfully.
• Browser access to NetBrain endpoint
  1. The client browser loads an embedded map from NetBrain Web Server directly, not through the third party website backend. With that said, the client browser must be able to access NetBrain endpoint.
  2. To test the connectivity, simply past NetBrain endpoint into the client browser and press enter. If there is no connectivity issue, NetBrain web page will be loaded successfully.