How do I enable the Geographical Map in ENA?

Permissions for the Geographical Map

To set up and enable the Geographical Map in ENA

To restrict the API key to a specific URL

To set daily limits on page loads

What functionality is added by enabling Geographical Map?

ENA's map dashlet allows you to view maps in either Topological or Geographical Map mode. The geographical mode is based on ENA's integration with the Google Maps API. This allows you to see the geographical distribution of the Subviews within a selected View against a geographical map provided by Google Maps.

Geographical Map is not enabled by default in ENA. You will need to set up a Google Maps Platform account, gain a Google Maps API key, and then save it in ENA. Please see below for instructions on how to execute these steps:

Permissions for the Geographical Map

Only Administrators can set up and enable the Geographical Map in ENA. This means that the Geographical Map option on the Administration page is only visible and accessible to Administrators.

The Geographical Map functionality is accessible to other users if they belong to a user group with the Geographical Maps tool permission. To enable this permission:

1. As an administrator, click Menu and then Administration. This will open the Administration page.
2. Click Account Management to open the Account Management page.
3. Under the Groups section, select the user group that you want to edit and click Tool Permissions.
4. Tick the Geographical Maps box.  Click OK to save your changes, otherwise click Cancel.
   

Without the Geographical Map permission, the Geographical Map functionality will not be visible or accessible to users.

To set up and enable the Geographical Map in ENA: 

1. On the Google Maps Platform, select the relevant APIs:
   1. Navigate to the Google Maps Platform page.
   2. Click Get started. This will open the Enable Google Maps Platform dialog.
   3. Tick the Maps and Places boxes, and click Continue.
      
2. Create a new Maps Project:
   1. In the Select or create project field, click + Create a new project and then enter a name for the project.
   2. Click Next.
      
3. Associate a billing account:
   
   1. Click Create Billing Account and enter the billing account details. Note, Google provide free credit each month that allows up to 28,000 page loads per month. After this threshold, the approximate cost will be $7.00 for every 1,000 page loads. Please see the daily limit section below for help on setting page load limits.
      
      In ENA, dashboards automatically refresh every 5 minutes. This will not result in a new page load. However, if you manually refresh the page, or navigate away and back to it again, then this will cause a new page load.
   2. Agree to the terms and conditions, and click Continue.
      
4. Enable your APIs, and copy and paste the API key into ENA:
   1. Enable the Google Maps APIs by clicking Next. Please note, the API key can take up to 8 minutes to activate, so it might not be immediately available.
      
   2. Copy the API key.
      
5. Navigate to ENA. Click Main Menu and then Administration.
6. On the Administration page, click Geographical Map. This will open the Geographical Maps page.
7. Click API Key Settings in the top right of the page. This will open the API Key Settings form.
8. Turn on the Enable Geographical Maps switch, and then paste the API key into the API Key field.
9. Click Done in the top right of the form, otherwise click Cancel.

To restrict the API key to a specific URL:

For security purposes, you can restrict the API key to a specific website URL so that it can only be used with a particular server.

1. Navigate to the Google Maps Platform page and ensure that you are signed in to your account. Click Console in the top right of the page. This will open the Console page
2. Click the Navigation Menu in the top left of the page. Click APIs & Services from the menu, and then Credentials.
3. Select the API key that you want to restrict from the list, and then click the Edit API key icon .
4. In the Application restrictions section, select the HTTP referrers (websites) option.
5. In the Website restrictions field below it, enter the server URL and ensure that you add /* after the URL.
6. Click Save at the bottom of the page to save your changes, otherwise click Cancel.
   

To set daily limits on page loads:

Google provide free credit each month that allows up to 28,000 page loads per month. After this threshold, the approximate cost will be $7.00 for every 1,000 page loads.

In ENA, dashboards automatically refresh every 5 minutes. This will not result in a new page load. However, if you manually refresh the page, or navigate away and back to it again, then this will cause a new page load.

You can set daily limits on page loads to prevent you from ever going abovoe the free credit page loads, and therefore prevent you from being billed:

1. Navigate to https://console.cloud.google.com/ and sign in with your account. This will take you to your Google Cloud Platform dashboard.
2. Click the Navigation Menu in the top left and then click API & Services.
   
   
   
   
3. On the API & Services page, scroll down to the table of APIs at the bottom of the page. Click Maps JavaScript API to open the Maps JavaScript API page.
   
   
   
   
4. Click the Quotas tab.
   
   
   
   
5. Scroll down to the table at the bottom of the page. On the Map loads per day entry, click the Edit icon. Enter a quota of 1,000 and click Save. This will mean that you do not exceed the 28,000 page loads permitted per month with the free Google credit, based on a 5-day working week and excluding weekends.
   
   

What functionality is provided by enabling geographical maps?

Enabling the Geographical Map mode provides new types of functionality to ENA:

• add a location to every View.
• addition of a dropdown toggle on every Map dashlet (at a View/Subview level), so that you can switch between topological mode and geographical mode.
• addition of a new set of geographical map options in the Create/Edit Map dashlet form that would otherwise not be visible.
• addition of a new View Location column to the View Contents dashlet table.

Please see the Geographical Map user guide and best practices article for further help and information on this functionality.