Creating Maps to Illustrate Trends

In this section:

How to:

Reference:

You can create maps to identify patterns or trends in your data. By converting data into values that can be displayed on a map, you are able to visualize scenarios, illustrate hot spots, and identify potential problem areas. For example, a law enforcement agency may use mapping functionality to identify areas of higher crime within the locations they cover. You can also use maps to determine how places are related, understand where things are located, and identify the best actions to take. By illustrating trends on a map, a decision maker can identify patterns easily, and reach conclusions sooner.

You can access Map options from the Format tab, as a special tab is activated when a map is initiated. This tab is shown in the following image:

You can format maps to display areas of emphasis through the use of demographic and reference layers.

A Brief History of Mapping

An early example of how maps can be used to illustrate trends is the case of Dr. John Snow, an epidemiologist who was one of the first to use data to map occurrences of cholera to find the cause of infection. By plotting the cholera data on a map of a town, Dr. Snow was able to visualize a trend that showed higher incidences of cholera closest to water pumps. This example is shown in the following image.

Maps also allow you to measure size, shape, and distribution to detect and quantify patterns, and even perform predictive analytics. An example of how maps can help detect and quantify patterns is the scenario in which a state agency used a mapping application to solve a problem with their food stamp system. Using this application, odd food stamp redemptions, such as rounded numbers transactions, were discovered. By plotting those transactions on a map, the agency discovered that the redemptions appeared in the same geographic location. Upon further investigation, the agency identified that individuals were selling their food stamps at reduced prices, $50 worth of food stamps for $40 in cash, to others instead using them as intended. This map example is shown in the following image.

When working with maps, the concepts of location intelligence and business intelligence are important to understand. A Geographic Information System (GIS) captures, stores, analyzes, manages, and presents data linked to a location, while Business Intelligence (BI) relies on the conversion of raw data into meaningful information. Location intelligence is the process of analyzing data to make better business decisions. It combines GIS and BI/Analytics to allow the recognition of patterns in your data, including the visualization and discovery of geospatial outliers, which would not be easily discovered if you use the technology independently and separately.

More specifically, maps use non-intrusive GIS workflows with existing data. You can view symbol layers for data-bound to a geo-location, such as state, country, and ZIP code, in an integrated map viewer. Using metrics from your data, you can also visualize geographic roles or dimensions. Geographic roles, or dimensions, can be built directly into your Metadata or assigned to a data field when you create a map.

ibi WebFOCUS Designer and Esri Integration

In this section:

How to:

Reference:

Using WebFOCUS Designer with the Esri integration, you can create maps that help you illustrate or identify trends so you can take action quickly. WebFOCUS architecture provides the framework in which this system operates. Using a JavaScript map viewer, you can navigate the interface easily, as shown in the following image.

In addition, this integration utilizes the capabilities of Esri by leveraging the ArcGIS JavaScript API and content. Specifically, you can integrate data into maps with published content in ArcGIS Online platform. For more information, see http://www.esri.com/software/arcgis/arcgisonline. Additionally, by using this integration, you can include information about demographics, spending habits, crime, and lifestyle to maps that contain your data. These maps include layers with extensive demographic or reference detail and topography and allow you to view information about people, businesses, climate, and much more.

You can create the following maps in WebFOCUS Designer:

In addition, built-in zooming capabilities allow you to drill down to a specific geographic area of focus easily. This allows you to get a closer look at regional or local data, draw inferences, and make recommendations, without changing the initial view of your data.

Using the Esri integration in WebFOCUS Designer, you can also add the following layers to your map:

Both mapextent and the Layers menu functionality are applied to your map when you select a Base map, Reference Layer, or Demographic Layer. Mapextent is an automatic view of the map. Layers is a menu that appears on the map and provides access to options that allow you to adjust the information that is being displayed.

The map example in the following image shows the use of layers.

Note: Demographic Layers and Reference layers can be accessed from the Add Content Layers button, and basemaps can be accessed from the Map Properties panel. These layers are static, standard options available from Esri, and do not change based on the data source that you select.

ibi WebFOCUS Server Adapter for Esri ArcGIS Configuration for Demographic Layers

How to:

In order for demographic layers to draw, you must configure the WebFOCUS Server to enable them. Some features, such as demographic and reference layers that require authentication and certain simplified geography functions, may additionally require a refresh token. You can acquire the refresh token using your Esri ArcGIS credentials.

Procedure: How to Configure the Adapter for Esri ArcGIS to Enable Demographic Layers to Draw

  1. From the plus menu of the WebFOCUS Hub, or from the WebFOCUS Home Page, click Get Data.
  2. On the Get Data page, double-click New Data Source.
  3. From the list of adapters, double-click ESRI ArcGIS.

    The Add Connection for Esri ArcGIS panel opens.

    Note: To find the Esri ArcGIS adapter option more easily, select GIS from the Available drop-down list, or use the search box.

  4. Basic connection parameters for this adapter are supplied automatically. To access secured Esri ArcGIS features that require named authentication, configure the Adapter for Esri ArcGIS with a refresh token.

    Click Get Refresh Token. The Esri ArcGIS Sign In page opens. Type your username and password and then click Sign In.

    You are returned to the Add Connection panel.

  5. In the Add Connection for Esri ArcGIS panel, click Configure, as shown in the following image.
    Connection parameters for ESRI ArcGIS adapter

    Once this is configured, ESRI ArcGIS is added to the Get Data page.

Configuring an Esri On Premise Environment

The Esri On Premise functionality enables you to download and access mapping files through the use of a local Application Programming Interface (API). Once you download and configure the API, you do not need an internet connection to utilize the robust mapping features that Esri provides. For information on downloading and configuring the API that controls this feature, see How to Download and Configure the ArcGIS JavaScript API.

The Esri On Premise functionality provides you with local access to Esri mapping files. This is particularly useful if you are away from your office or without an internet connection. You may also be using a mobile device, such as an iPad or smartphone with a large screen, without an internet connection. The following mapping components are supported when using the Esri On Premise functionality:

  • Offline Basemaps. Basemaps are an offering from ArcGIS. Standard basemaps are provided for your use offline. For example, there is an Oceans basemap and a Terrain with Labels basemap. These basemaps are also known as backgrounds. In an online setting, there are 10 basemaps available. In order to use offline basemaps you need to use a tiled mapservice published in the ArcGIS Server.
  • Offline Geographic Roles. Geographic Roles are used to visualize measures with commonly known dimensions (for example, Country, State, Cities, and so on). These provide the location information often in the form of (x/y) needed to plot on a map. Geographic roles are pre-defined for online users through ArcGIS Online. A geographic role defines the geographic component that you can select when creating a map (for example, State or Continent). For an offline user, the options that display can be customized in the geoservices.xml file. For more information, see Adding a Custom Geographic Role.

Note: Demographic Layers are not supported in an Esri On Premise environment.

Procedure: How to Download and Configure the ArcGIS JavaScript API

You can use this procedure to download and configure the API that controls the Esri On Premise environment.

  1. Sign in to Esri ArcGIS.
  2. In your browser, navigate to the following URL to download the API: https://developers.arcgis.com/downloads/#javascript
  3. Navigate to Version 3.28 of the ArcGIS API for JavaScript, as shown in the following image.
  4. Click arcgis_js_v328_api.zip to download the API.
  5. In drive:\ibi\WebFOCUSnn\config\web_resource /qibm/userdata/qwebqry/base80/config/web_resource, create a folder named arcgis_api.
  6. Open the arcgis_js_v328_api.zip file downloaded in step 4 and navigate to arcgis_js_v328_api\arcgis_js_api\library\3.28\3.28.
  7. Extract the files in that folder to the drive:\ibi\WebFOCUSnn\config\web_resource\arcgis_api folder /qibm/userdata/qwebqry/base80/config/web_resource/arcgis_api folder.
  8. Next, verify the path to the API in the Administration Console, as shown in the following image.

    Note: This is the path to which you extracted the API files. For example, /web_resource/arcgis_api.

    This field identifies the path to the internal ArcGIS Javascript API Source that develops ESRI-based maps. This setting is blank, by default, indicating that the use of the internal API source to develop ESRI maps is not activated. The API that is referenced is https://js.arcgis.com/3.28/, by default. To direct WebFOCUS Designer to use the internal ArcGIS Javascript API to develop ESRI maps, enter the path to the local API files that you extracted into this setting. For more information, see the WebFOCUS Security and Administration manual.

    Note: This path should be a relative path that is accessible within the local install.

  9. Click Save.
  10. Next, open the following two local API files in a text editor:
    • drive:\ibi\WebFOCUSnn\config\web_resource\arcgis_api\init.js
    • drive:\ibi\WebFOCUSnn\config\web_resource\arcgis_api\dojo\dojo.js
    • /qibm/userdata/qwebqry/base80/config/web_resource/arcgis_api\init.js
    • /qibm/userdata/qwebqry/base80/config/web_resource/arcgis_api\dojo\dojo.js

    In both files, search for HOSTNAME_AND_PATH_TO_JSAPI to locate the baseUrl property. Replace the string [HOSTNAME_AND_PATH_TO_JSAPI] in baseUrl:"https://[HOSTNAME_AND_PATH_TO_JSAPI]dojo" with the path to your on-premise ArcGIS server. For example:

    baseUrl:"https://localhost/arcgis/jsapi/jsapi/dojo"
  11. In the Administration Console, click Clear Cache to clear the browser cache. Your configuration is complete.

Creating and Customizing Maps in ibi WebFOCUS Designer

The following procedures provide step-by-step instructions on how to create and customize maps.

As you create your maps, you can use the following built-in map viewer features:

  • You can use the plus (+) and minus (-) symbols, , within the map to zoom in and out of different areas of the map. You can also click your left mouse button to zoom in to a specific location.
  • Like all HTML5 visualizations, the highlighted markers and regions on a map support drill, multi-drill, auto-linking, and informational tooltip features.
  • You can use the Pan / Selection button to alternate between the Pan and Selection controls. This option is in the upper-right corner of the map.
  • Creating a map chart using the US Zipcode 5 Georole with more than 2000 polygons will fail to draw.

Procedure: How to Create an Esri Choropleth Map

Note: The default option of creating a map utilizes the ArcGIS JavaScript API that Esri provides.

  1. Open WebFOCUS Designer. On the WebFOCUS Hub, click the plus menu and then click Create Visualizations, or, on the WebFOCUS Home Page, click Visualize Data.

    WebFOCUS Designer opens in a new browser tab.

  2. Select a workspace and a data source available from that workspace.

    Once you select a data source, WebFOCUS Designer loads with options to create a single content item.

  3. On the Content picker, select the Choropleth map chart type.

    A blank map displays and the Location bucket is enabled, as shown in the following image.

    Empty choropleth map in WebFOCUS Designer
  4. Add a Geolocation field to the Location bucket.

    This field, which already has a geographic role assigned, is denoted with a Location icon, , in the Resources panel.

    The canvas refreshes, and your map displays.

  5. Before saving your map, to add insight, you can also do the following:
    • Click Run in new window, to see a run-time view of your map.
    • Add a measure or dimension to the Color bucket, to color your chart by that underlying data value. When you add a dimension field to the Color bucket, a legend displays for the values in that field. Note that each area in a choropleth map can only display one color at a time, so it may be preferable to use a dimension for which each geographic area will return a single value. If you specify a measure in the Color bucket, a color scale is generated.
    • Add a field to the Tooltip bucket, which will display tooltip information when you place your mouse over an area of the map.
    • Add a Base map, Demographic Layer, or Reference Layer from the Format tab, under Map options.
  6. Click Save to save your map.

Procedure: How to Create an Esri Proportional Symbol (Bubble) Map

  1. Open WebFOCUS Designer. On the WebFOCUS Hub, click the plus menu and then click Create Visualizations, or, on the WebFOCUS Home Page, click Visualize Data.

    WebFOCUS Designer opens in a new browser tab.

  2. Select a workspace and a data source available from that workspace.

    Once you select a data source, WebFOCUS Designer loads with options to create a single content item.

  3. On the Content picker, select Proportional Symbol for the map type.

    A blank map displays and the Location bucket is enabled.

  4. Place a data field with a defined geographic role in the Location bucket.

    This field, which already has a geographic role assigned, is denoted with a Location icon, , in the Resource panel.

    A basic bubble map displays, as shown in the following image.

    Bubblemap with only a location field (country)
  5. Before saving your map, to add insight, you can also do the following:
    • Click Run in new window, to see a run-time view of your map.
    • Add a measure or dimension to the Color bucket to color your chart by that underlying data value. Adding a dimension creates a legend with a different color assigned to each value. Adding a measure generates a color scale.
    • Add a measure to the Size bucket, to control the size of the bubbles on your map.
    • Add a field to the Tooltip bucket, to display tooltip information when you place your mouse over an area of the map at run time.
    • Add a Resources Panel, Demographic Layer, or Reference Layer from the Format tab, under Map options.
  6. Click Save to save your map.

Procedure: How to Change the Default Background of a Map

  1. Create a new map or open an existing map.
  2. Click the Map Properties button.
  3. In the Map Properties panel, open the Basemap menu and choose from the available options, as shown in the following image.
    List of available basemaps
  4. Select one of the following options:
    • Basemap None
    • Dark Gray Canvas Map
    • Dark Gray Vector
    • Light Gray Canvas Map
    • Gray Vector
    • World Imagery with Labels
    • National Geographic World Map
    • Oceans Map
    • Open Street Map
    • World Imagery
    • World Street Map
    • Streets Navigation Vector
    • Streets Night Vector
    • Streets Relief Vector
    • Streets Vector
    • Terrain with Labels
    • World Topographic Map
    • Topographic Vector

    Note: Custom configured basemaps also appear as options.

    Vector basemaps can be more detailed than default raster tile basemaps, but may not be compatible with all environments or basemap styles. For some basemaps, both default raster tile and vector options are available.

    Once you make a selection, the background of the map refreshes. You can continue to change your background until it displays the desired information.

Procedure: How to Add Demographic Layers to a Map

  1. Create a new map or open an existing map.
  2. Click Add Content Layer(s) to add a new content layer.
  3. In the Add Content Layer(s) dialog box, on the Demographic tab, select from various population and lifestyle groups, as shown in the following image

    Note: These are pre-defined demographic profiles, provided by Esri ArcGIS. Esri periodically retires older demographic layers.

    You can select multiple options in either category to gain additional insight into your data. Specifically, each Demographic Layer has its own profile and provides a layering option, when comparing values across different layers or profiles.

  4. Once you select the demographic layers in the list on the left that you want to use, click Add > to add them to the selected list on the right.
  5. Click Add to add the select layers to the map.

    The Demographic Layers that you select are rendered on the map. The legends for each layer, if they are available, display in the Layers list at run time. The Layer list with a configured demographic layer is shown in the following image.

    legend for Tapestry demographic layer

    You can select and clear the check boxes to enable the display of one or more Demographic Layers to compare and contrast the different demographic scenarios.

    Note: Layers that require a special layerTypeEx property in the addon_json when configured, are not supported in the com.esri.map extension. InfoAssist uses the com.esri.map extension.

Procedure: How to Add Reference Layers to a Map

  1. Create a new map or open an existing map.
  2. Click Add Content Layer(s) to add a new content layer. In the Add Content Layer(s) dialog box, select the Reference tab, as shown in the following image.
  3. Select the reference layers that you want to use from the list on the left, and click Add > to add them to the selected list on the right. Click Add to add the selected layers to the map.

    Your map refreshes, and the definitions and borders of the References Layers display on the canvas. You can use the Table of Contents or Layers option, to toggle different Reference Layers in your map. These options are shown in the following image.

Reference: Query Buckets by Map Type

This section presents the Query buckets that display, by map type.

Query bucket

Choropleth Map

Proportional Symbol Map

Location. One data field, specifically a field containing location data (for example, State).

Color. One data field.

Tooltip. One or more data fields (not required).

Multi-page. Up to one data field (not required).

Size. One data field.

Reference: Geographic Roles

Geographic roles have been unified to access 58 world administrative boundaries down to the postal code level, out of the box. You can access administrative boundaries for approximately 250 countries with a second level license, which is a paid service from Esri. Enter your second level license code by clicking the License button on the ribbon.

Note: Geographic roles are only available with Esri maps.

This section contains information on the geographic roles that are supported for Esri maps.

Geographic Role

Description

Maps Supported

CONTINENT

World Continents

Choropleth, Proportional Symbol

COUNTRY

World Countries

Choropleth, Proportional Symbol

STATE

World Admin Divisions

Choropleth, Proportional Symbol

CITY

World Cities

Proportional Symbol

COUNTY

World Counties

Choropleth, Proportional Symbol

POSTAL-CODE

Postal Code

Choropleth, Proportional Symbol

Note: This is a new, simplified list of geographic roles (dimensions) that you can utilize when creating a map chart. This unified list of roles provides worldwide mapping of administrative boundaries down to the postal code level. In WebFOCUS Designer, the new roles display, by default, when assigning a geographic role.

The following table illustrates the geographic roles and their dependencies. Level 1 indicates the highest level of hierarchy and level 5 is the lowest level of hierarchy.

Region

Hierarchy Level

Geographic Role

World

1

CONTINENT

2

COUNTRY

3

STATE

4

CITY

5

POSTAL CODE

Procedure: How to Access Second Level Licensed Geographies for Esri Maps

  1. Click Workspace on the Reporting Server Web Console sidebar.
  2. Click License on the ribbon.

    The License Management pane opens, as shown in the following image.

  3. Enter your Esri second level license code in the license_2nd_level_maps field.
  4. Click Save and Restart Server.

Once the second level license is enabled, you can use the standard administrative and postal geographic roles to access these additional geographic boundaries.

Note: The server must be configured for Unicode if Unicode characters exist in the data.

Reference: List of Geographic Locations

The WebFOCUS Server Console provides a list of first and second level map administrative regions. To open the list, select Server Workspaces from the Management Center on the Hub, click the Settings menu on the Workspace page ribbon, point to Geo Services, and select General maps info. This opens the list of administrative regions and postal levels, as shown in the following image.

The regions that say Paid in the Maps license column are the additional regions you can access with a second level license.

  • The source for the country administrative level is provided by the Esri World map. Country is administrative level 0.
  • The source for the State georole can be provided by the Esri World map or by shape files. When there is a second level license, the state administrative level can be level 1 or level 2.
  • The source for the County georole can be provided by the Esri World map or by shape files. When there is a second level license, the county administrative level can be level 3 or level 4.
  • The source for the City georole can be provided by the Esri World map or by shape files. When there is a second level license, the city administrative level is level 5.
  • The source for the Postal Code georole can be provided by the Esri World map or by shape files. When there is a second level license, the postal code administrative level can be 3, 4, or 5.

Some georoles may not be applicable to specific countries. You can see the details of each country and its administrative levels by right-clicking the country name and clicking Drill to administrative levels or Drill to postal levels, as shown in the following image.

Clicking Drill to administrative levels opens the list of States for the country, as shown in the following image.

Clicking any link opens information about the next level georole.

Clicking Drill to postal levels opens the list of postal levels for the country, as shown in the following image.

Right-clicking a link in any georole column other than the Country column opens a summary of the values for that georole, as shown in the following image.

Administrative Boundaries for Level 1 Countries

Administrative boundaries for the United States are automatically included by Esri.

The following table lists the Level 1 countries and their Level 1 and Level 2 administrative levels for available world countries and territories. For some countries, no additional administrative levels are added with a second level license.

Country

Postal Code

Level 1 Administrative Level

(Number of Values)

Level 2 Administrative Level

(Number of Values)

Albania

2 - digit

Qarke (12)

Bashkia (61)

Andorra

5 - digit

Parroquies (7)

 

Argentina

5 - digit

Departamentos (525)

 

Australia

4 - digit

Local Government Areas (569)

 

Austria

4 - digit

Gemeinden (2120)

 

Belarus

6 - digit

Woblaszi (7)

Raioni (129)

Belgium

4 - digit

Communes (589)

 

Bosnia and Herzegovina

5 - digit

Kantone (18)

Opstine (142)

Brazil

5 - digit

Municipios (5565)

 

Canada

3 - digit

Census Divisions (293)

Census Subdivisions (5243)

Chile

2 - digit

Provincias (54)

 

China

2 - digit

Counties City Districts (2855)

 

Costa Rica

2 - digit

Cantones (81)

Distritos (473)

Croatia

2 - digit

5-digit for 2nd level license

Zupanije (21)

Opcine (556)

Cyprus

2 - digit

4-digit for 2nd level license

Eparchia (6)

Dimoi (615)

Czech Republic

2 - digit

6-digit for 2nd level license

Orp (206)

Obce (6253)

Denmark

4 - digit

Kommuner (99)

 

Estonia

5 - digit

Maakonnad (15)

Vallad (213)

Finland

5 - digit

Seutukunnat (70)

Kunnat (317)

France

5 - digit

Cantons (1972)

Communes (36571)

Germany

5 - digit

Municipilaties

 

Gibraltar

3/4/5 - digit

 

Greece

5 - digit

Nomoi (75)

Dimoi (326)

Holy See (Vatican City State)

5 - digit

 

Hong Kong

6 - digit

Shih Zizhiqu (18)

 

Hungary

2 - digit

4-digit for 2nd level license

Kistersegek (175)

Telepulesek (3177)

Iceland

2 - digit

3-digit for 2nd level license

Landsvaedi (8)

Sveitarfelog (74)

India

6 - digit

Districts (640)

Subdistricts (5783)

Italy

5 - digit

Provincias (110)

Comuni (8047)

Japan

3 - digit

Prefectures (47)

Municipalities (1901)

Kenya

1 - digit

Wilaya (47)

Districts (158)

Korea, Republic of

3 - digit

Si Gun (230)

 

Latvia

2 - digit

4-digit for 2nd level license

Rajons (33)

Novadi (119)

Liechtenstein

4 - digit

Landschaften (2)

Gemeinden (11)

Lithuania

2 - digit

5-digit for 2nd level license

Apskritys (10)

Savivaldybes (60)

Luxembourg

4 - digit

Cantons (12)

Communes (105)

Macedonia, the former Yugoslav Republic of

2 - digit

4-digit for 2nd level license

Statisticki Regioni (8)

Opstini (80)

Malta

3 - digit

Districts (6)

Local Councils (68)

Mexico

3 - digit

Estados (32)

 

Monaco

5 - digit

Quartiers (9)

 

Montenegro

2 - digit

5-digit for 2nd level license

Opstina (21)

 

Netherlands

4 - digit

Gemeenten (380)

 

New Zealand

4 - digit

Territorial Authorities (68)

Area Units (1911)

Norway

4 - digit

Okonomisk regioner (89)

Kommuner (428)

Poland

5 - digit

Gminy (2479)

Gminy Miasta (3119)

Portugal

4 - digit

Concelhos (308)

Freguesias (3092)

San Marino

5 - digit

Castelli (9)

 

Serbia

5 - digit

5-digit (1156) for 2nd level license

National (1)

 

Singapore

2 - digit

Regions (5)

Planning Areas (55)

Slovakia

2 - digit

6-digit for 2nd level license

Okresy (79)

Obce (2927)

Slovenia

2 - digit

4-digit for 2nd level license

Statisticne Regije (12)

Obcina (212)

South Africa

2-digit

4-digit for 2nd level license

Municipalities (234)

 

Spain

5 - digit

Provincias (52)

Municipios (8122)

Sweden

5 - digit

Kommuner (290)

 

Switzerland

4 - digit

Gemeinden (2225)

 

Taiwan

3 - digit

Township Districts (368)

 

Turkey

5 - digit

Iller (81)

Ilceler (970)

United Kingdom

4 - digit

Districts (391)

 

Administrative Boundaries for Level 2 Countries

The following table lists countries that are accessible only with a second level license.

Country

Postal Code

Highest Administrative Level

(Number of Values)

Lowest Administrative Level

(Number of Values)

Afghanistan

4-digit

Velayat (34)

Woluswali (398)

Algeria

2-digit

Wilayat (48)

American Samoa

5-digit

Counties (77)

 

Angola

 

Provincias (18)

Municipios (161)

Anguilla

7-digit

Districts (14)

 

Antigua and Barbuda

 

Parishes (8)

 

Armenia

2-digit

Marzer (11)

 

Aruba

 

Districts (8)

 

Azerbaijan

2-digit

Regions (10)

Rayonlar (74)

Bahamas

 

Islands (19)

Districts (32)

Bahrain

2-digit

Muhafazat (5)

 

Bangladesh

2-digit

Zila (64)

Upazila (553)

Barbados

 

Parishes (11)

 

Belize

 

Districts (6)

Constituencies (31)

Benin

 

Departements (12)

Communes (77)

Bermuda

4-digit

Parishes (11)

 

Bhutan

2-digit

Dzongkhags (20)

 

Bolivia, Plurinational State of

 

Departamentos (9)

Provincias (112)

Botswana

 

Districts (9)

Sub-Districts (28)

British Virgin Islands

 

National (1)

Electoral Districts (9)

Brunei Darussalam

2-digit

Daerah (4)

Mukim (38)

Burkina Faso

 

Regions (13)

Provinces (45)

Burundi

 

Provinces (17)

Communes (129)

Cambodia

 

Khaet (25)

 

Cameroon

 

Regions (10)

Departements (58)

Cape Verde

2-digit

Concelhos (22)

Freguesias (32)

Cayman Islands

8-digit

Districts (6)

 

Central African Republic

 

Prefectures (17)

Sous-Prefectures (51)

Chad

 

National (1)

 

Colombia

2-digit

Departamentos (33)

Municipios (1122)

Comoros

 

Islands (3)

 

Congo

 

Departements (12)

 

Congo, the Democratic Republic of the

 

Districts (48)

Territoires (188)

Côte d'Ivoire

 

Regions (32)

Departements (95)

Cuba

 

Provincias (16)

Municipios (168)

Djibouti

 

Regions (6)

 

Dominica

 

Parishes (10)

 

Dominican Republic

5-digit

Provincias (32)

Municipios (155)

Ecuador

6 - digit

Cantones (224)

Parroquias (1040)

Egypt

2-digit

States (27)

 

El Salvador

7-digit

Departamentos (14)

Municipios (262)

Equatorial Guinea

 

Regions (2)

Provinces (7)

Eritrea

 

Zobas (6)

Subzobas (52)

Ethiopia

 

Kililoch (11)

Awrajja (85)

Faroe Islands

3 - digit

Syslur (6)

Kommunur (30)

Fiji

 

Provinces (15)

 

French Guiana

5-digit

Cantons (14)

Communes (22)

French Polynesia

5-digit

Iles (5)

Communes (48)

French Southern Territories

 

Districts (4)

 

Gabon

 

Provinces (9)

 

Gambia

 

Local Government Areas (8)

 

Georgia

 

Regions (12)

Rajone (77)

Ghana

 

Regions (10)

Districts (216)

Greenland

4-digit

Kommuner (6)

 

Grenada

 

Parishes (7)

 

Guadeloupe

5-digit

Cantons (28)

Communes (32)

Guam

5-digit

County Subdivisions (19)

 

Guatemala

5-digit

Departamentos (22)

Municipios (334)

Guernsey

5-digit

Parishes (15)

 

Guinea

 

Regions (8)

Prefectures (34)

Guinea-Bissau

4-digit

Regioes (9)

Sectores (38)

Guyana

 

Regions (10)

 

Haiti

 

Arrondissements (42)

Communes (140)

Honduras

2-digit

Departamentos (18)

Municipios (298)

Indonesia

3-digit

States (34)

 

Iran, Islamic Republic of

1-digit

Provinces (31)

Subprovinces (397)

Iraq

 

Muhafazat (18)

Kaza (109)

Ireland

 

Counties (34)

Electoral Divisions (3441)

Isle of Man

5-digit

Sheadings (6)

Districts (24)

Israel

2-digit

States (6)

 

Jamaica

 

Parishes (14)

Constituencies (62)

Jersey

5-digit

Parishes (12)

 

Jordan

5-digit

Muhafazat (12)

Nahia (51)

Kazakhstan

4-digit

Oblystar (16)

Audandar (209)

Korea, Democratic People's Republic of

 

Do (14)

 

Kosovo

2-digit

Obstina (38)

 

Kuwait

2-digit

Muhafazat (6)

Localities (137)

Kyrgyzstan

4-digit

Oblasttar (9)

Rajondor (46)

Lao People's Democratic Republic

 

Khoueng (17)

Muang (142)

Lebanon

 

Muhafazat (6)

Caza (26)

Lesotho

 

Districts (10)

 

Liberia

 

Counties (15)

 

Libyan Arab Jamahiriya

 

Schabiyat (22)

 

Macao

6-digit

Parishes (8)

 

Madagascar

3-digit

Regions (22)

Districts (114)

Malawi

 

Regions (3)

Districts (30)

Malaysia

2-digit

Negeri (16)

Daerah (144)

Maldives

2-digit

Atolls (20)

 

Mali

 

Regions (9)

Cercles (50)

Marshall Islands

3-digit

Municipalities (34)

 

Martinique

5-digit

Arrondissements (4)

Communes (34)

Mauritania

 

Wilayas (13)

Moughataas (53)

Mauritius

 

Districts (10)

 

Mayotte

 

Communes (17)

 

Micronesia, Federated States of

5-digit

States (4)

 

Moldova, Republic of

4-digit

Raioane (37)

 

Mongolia

4-digit

Aimags (22)

Sums (338)

Montserrat

 

Parishes (3)

 

Morocco

2-digit

Regions (16)

Provinces (75)

Mozambique

2-digit

Provincias (11)

Distritos (142)

Myanmar

 

States and Divisions (15)

 

Namibia

 

Regions (13)

Constituencies (119)

Nauru

 

Districts (14)

 

Nepal

 

Zones (14)

Districts (75)

New Caledonia

5-digit

Provinces (3)

Communes (34)

Nicaragua

 

Departamentos (17)

Municipios (153)

Niger

 

Regions (8)

 

Nigeria

 

States (37)

Local Government Areas (774)

Northern Mariana Islands

5-digit

Municipalities (4)

 

Oman

1-digit

Muhafazat (11)

Wilayat (61)

Pakistan

2-digit

Provinces (8)

Districts (146)

Palau

5-digit

States (16)

 

Palestinian Territory, Occupied

 

Territories (2)

Muhafazat (16)

Panama

 

Provincias (12)

Distritos (76)

Papua New Guinea

 

Provinces (22)

Districts (87)

Paraguay

 

Departamentos (18)

Distritos (251)

Peru

2 - digit

Provincias (195)

Distritos (1834)

Philippines

4-digit

Provinces (87)

Municipalities and Cities (1634)

Pitcairn

8-digit

Islands (4)

 

Puerto Rico

5-digit

Municipios (78)

County Subdivisions (902)

Qatar

 

Municipalities (7)

Zones (90)

Republic of South Sudan

 

States (10)

 

Réunion

5-digit

Arrondissements (4)

Communes (24)

Romania

6 - digit

Judete (42)

Comune (3181)

Russian Federation

4-digit

Federal Subjects (80)

Raioni (2345)

Rwanda

 

Provinces (5)

Districts (30)

Saint Kitts and Nevis

 

States (2)

Parishes (14)

Saint Lucia

 

Quarters (10)

 

Saint Vincent and the Grenadines

4-digit

Parishes (6)

 

Samoa

3-digit

Regions (4)

Districts (43)

Sao Tome and Principe

 

Province (2)

Distritos (7)

Saudi Arabia

2-digit

States (13)

 

Senegal

 

Regions (14)

 

Seychelles

 

Districts (25)

 

Sierra Leone

 

Provinces (4)

Districts (14)

Solomon Islands

 

Provinces (10)

 

South Sudan

2-digit

States (10)

 

Sri Lanka

2-digit

Districts (25)

DS-Divisions (331)

Sudan

2-digit

States (15)

 

Suriname

 

Districten (10)

Ressorten (62)

Svalbard and Jan Mayen (IE)

 

Counties (34)

Electoral Divisions (3441)

Svalbard and Jan Mayen (SJ)

4-digit

National (1)

Kommuner (4)

Swaziland

1-digit

Districts (4)

 

Syrian Arab Republic

 

Muhafazat (14)

Manatiq (61)

Tajikistan

 

Regions (5)

Raioni (64)

Tanzania, United Republic of

 

Mkoa (30)

Wilayah (169)

Thailand

2-digit

Changwate (77)

Amphoe (928)

Timor-Leste

 

Districts (13)

Subdistricts (65)

Togo

 

Regions (5)

 

Tokelau

 

Atolls (3)

 

Tonga

 

Island Divisions (5)

 

Trinidad and Tobago

 

Municipalities (15)

 

Tunisia

4-digit

Wilayat (24)

 

Turkmenistan

3-digit

Welayaty (6)

Etraplar (65)

Turks and Caicos Islands

8-digit

Districts (6)

Localities (38)

Tuvalu

 

Islands (9)

 

Uganda

 

Consolidated Districts (75)

Counties (110)

Ukraine

3-digit

Obstina (38)

 

United Arab Emirates

 

States (7)

 

United States Minor Outlying Islands

 

Islands (5)

 

United States Virgin Islands

5-digit

National (1)

Islands (3)

Uruguay

5 - digit

Secciones (232)

Segmentos (4301)

Uzbekistan

4-digit

Viloyati (14)

Tuman (171)

Vanuatu

 

Provinces (6)

 

Venezuela, Bolivarian Republic of

2 - digit

Estados (25)

Municipios (367)

Viet Nam

2 - digit

Provinces (63)

Districts (698)

Wallis and Futuna

5 - digit

Kingdoms (3)

 

Yemen

 

Muhafazat (21)

Muderiah (333)

Zambia

5 - digit

Provinces (10)

Districts (103)

Zimbabwe

 

Provinces (10)

Districts (91)

Example: Using a Second Level License to Map French Postal Codes

The request used in this example references data about French state names, city names, and postal codes. This data is readily available online. The data in this example was downloaded from https://www.aggdata.com/free/france-postal-codes which is available for free using a Creative Commons Attribution 4.0 license detailed at https://creativecommons.org/licenses/by/4.0/. Once you download the data, you can upload it to the server to create the data file and synonym for use in requests. This example assumes that the data and synonym are in the ibisamp application on the server.

Note: Information Builders takes no responsibility for the accuracy or continued existence of this data on this site. It is being used only as an example of the detailed administrative boundaries available with a second level license.

The Master File for the uploaded data follows. The Master File generated by the upload procedure was edited to change the first field name to COUNTRY and to remove the folder declarations.

FILENAME=FR_POSTAL_CODES, SUFFIX=DFIX    ,
 DATASET=ibisamp/fr_postal_codes.ftm (LRECL 1140 RECFM V, BV_NAMESPACE=OFF, $
  SEGMENT=FR_POSTAL_CODES, SEGTYPE=S0, $
    FIELDNAME=COUNTRY, ALIAS=E01, USAGE=A50V, ACTUAL=A50V,
      TITLE='Country for State',
      GEOGRAPHIC_ROLE=COUNTRY,  $
    FIELDNAME=STATE, ALIAS=E02, USAGE=A21V, ACTUAL=A21V,
      MISSING=ON,
      TITLE='State',
      GEOGRAPHIC_ROLE=STATE,  $
    FIELDNAME=COUNTY, ALIAS=E03, USAGE=A25V, ACTUAL=A25V,
      MISSING=ON,
      TITLE='County',
      GEOGRAPHIC_ROLE=COUNTY,  $
    FIELDNAME=CITY, ALIAS=E04, USAGE=A48V, ACTUAL=A48V,
      MISSING=ON,
      TITLE='City',
      GEOGRAPHIC_ROLE=CITY,  $
    FIELDNAME=POSTAL_CODE, ALIAS=E05, USAGE=A16V, ACTUAL=A16V,
      MISSING=ON,
      TITLE='Postal Code',
      GEOGRAPHIC_ROLE=POSTAL-CODE,  $
    FIELDNAME=PLACE_NAME, ALIAS=E06, USAGE=A56V, ACTUAL=A56V,
      MISSING=ON,
      TITLE='Place Name', $
    FIELDNAME=GEO_POINT, ALIAS=E07, USAGE=A150, ACTUAL=A150,
      TITLE='GIS Point',
      GEOGRAPHIC_ROLE=GEOMETRY_POINT,  $
  

The Access File for the uploaded data follows.

SEGNAME=FR_POSTAL_CODES, 
  DELIMITER=',', 
  CDN=COMMAS_DOT, 
  CONNECTION=<local>, $

The following WebFOCUS Procedure generates a choropleth map that shows the postal codes from the uploaded data source. The DEFINE field is used to assign different numeric values to each field. When used in the Color bucket, this DEFINE field makes it easier to differentiate the different postal code areas.

DEFINE FILE fr_postal_codes
 FOURTH_CHAR/I1 ( TITLE = 'Fourth,Character' ) =
		SUBSTRING(FR_POSTAL_CODES.FR_POSTAL_CODES.POSTAL_CODE, 4, 1);
END

SET COMPONENT=TableChart_1
SET ARVERSION=2
-DEFAULTH &WF_TITLE='WebFOCUS Report';

GRAPH FILE fr_postal_codes
SUM FOURTH_CHAR
BY FR_POSTAL_CODES.FR_POSTAL_CODES.POSTAL_CODE
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET VZERO OFF
ON GRAPH SET GRWIDTH 1
ON GRAPH SET HAXIS 1008.0
ON GRAPH SET VAXIS 768.0
ON GRAPH SET LOOKGRAPH CHOROPLETH
ON GRAPH SET EMBEDHEADING ON
ON GRAPH SET AUTOFIT ON
ON GRAPH SET STYLE *
INCLUDE=IBFS:/WFC/Global/Themes/Standard/Default/theme.sty,$
TYPE=REPORT, TITLETEXT='Chart1', ORIENTATION=LANDSCAPE, ARREPORTSIZE=DIMENSION, 
	ARFILTER_TARGET='*', CHART-LOOK=com.esri.map, ARGRAPHENGINE=JSCHART, $
TYPE=DATA, COLUMN=N2, BUCKET=color, $
*GRAPH_SCRIPT

*GRAPH_JS_FINAL
"extensions": {
    "com.esri.map": {
        "overlayLayers":             [
                {
                    "ibiDataLayer": {
                        "map-metadata": {
"map_by_field": "FR_POSTAL_CODES.FR_POSTAL_CODES.POSTAL_CODE"
                        }
                    }
                }
            ],
        "baseMapInfo": {
            "customBaseMaps":                 [
                    {
                        "ibiBaseLayer": "dark-gray"
                    }
                ]
        }
    }
}

*END
ENDSTYLE
END

When you run this procedure, the map displays postal codes in France, as shown in the following image.


Map of France with postal codes

Adding a Custom Geographic Role

Reference:

The GEO configuration editor in the WebFOCUS Reporting Server provides a tool for editing or adding properties for geographic roles.

On the WebFOCUS Hub, from the Management Center, click Server Workspaces to access the WebFOCUS Reporting Server Workspace area. Alternatively, from the WebFOCUS Home Page, click the Settings menu and click WebFOCUS Server. When the WebFOCUS Reporting Server browser interface opens, open the Tools menu and click Workspace. The Workspace area opens.

In the Reporting Server Workspace area click Settings, point to Geo Services, then click Edit Configuration. The GEO configuration editor opens displaying the configured geographic roles, as shown in the following image.

Reference: Editing the List of Geographic Roles

The following standard unified geographic roles are configured by default and cannot be changed. These geographic roles create a hierarchy that can be used to drill down or up between levels of administration in maps, reports, or charts.

  • CONTINENT.
  • COUNTRY.
  • STATE.
  • COUNTY.
  • CITY.
  • POSTAL CODE.

To add a geographic role to the configuration, you can add a new Esri map or a shapefile hosted by the Server and associate a geographic role with the new map. You can also implement NUTS geographic roles support.

Note: Some users may not be able to run maps with custom geographic roles when the default reporting server security configuration is in place. To allow a user to run content with custom geographic roles, on the Access Control page of the Reporting Server browser interface, right-click the role that the user privileges are based on and click Directory/File Privileges, then enable both the Execute and List privileges for geo_services_user.xml.

Configuring Properties of Geographic Roles

The following describes columns for geographic roles in the configuration editor.

name

Is the unique name of the geographic role. It cannot have spaces, but it can have underscores (_).

Next to the name is an indicator of whether the role is a standard role or a customized role.

title

Is the description of the geographic role that is displayed in reports and in drop-down lists in the WebFOCUS tools.

returned_geometry

Is the type of geographic data returned from the map service for rendering on the map.

Valid values include:

  • GEOMETRY_AREA
  • GEOMETRY_POINT
  • GEOMETRY_LINE

When you have configured the properties, click OK to return to the Geo Configuration Editor.

The new role will display on the list of roles, click Save to save it in the geographic configuration.

Adding a New Role for an Esri Map

To add an Esri geographic role, click Add ESRI map on the Geographic Configuration Editor.

The Create a new ESRI map role dialog box opens, as shown in the following image.

Configure the following map service properties.

name

Is a name for the geographic role.

title

Is a title to display in the WebFOCUS tools.

returned_geography

Select the type of geometry that is returned from the map service for this role. Valid values are:

  • GEOMETRY_AREA. Returns JSON polygon definitions.
  • GEOMETRY_LINE. Returns JSON line definitions.
  • GEOMETRY_POINT. Returns a JSON point.
url

Is the URL to the map service that provides the geographic data.

Click Verify after entering the URL to verify that the map service is available by going to the specified URL.

Service Parameters

Add as parameters any additional geographic roles needed to identify the exact location of the new role. For example, a city name needs state and country parameters.

Example: Adding the WebFOCUS Regions Geographic Role

The following properties add the WebFOCUS Regions role to the configuration.

Note: The parameter name corresponds to the field name in the FeatureLayer referenced in the following URL:

http://services7.arcgis.com/L95Wwv9OjRQ0tjAs/ArcGIS/rest/services/wfretail_sub_regions/FeatureServer/0

Click OK when you have finished configuring the properties.

The new role is added to the configuration as a customized role, as shown in the following image.

Click Save to save this role to the configuration.

The following request uses the WebFOCUS Regions geographic role in a map request.

DEFINE FILE WF_RETAIL_LITE

REGION/A50 (GEOGRAPHIC_ROLE=REGION) = BUSINESS_SUB_REGION;
END
 
GRAPH FILE WF_RETAIL_LITE
SUM COGS_US
BY REGION
WHERE COUNTRY_NAME EQ 'United States'
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET LOOKGRAPH CHOROPLETH
ON GRAPH SET STYLE *
TYPE=REPORT, CHART-LOOK=com.esri.map, $
TYPE=DATA, COLUMN=N2, BUCKET=color, $
*GRAPH_JS_FINAL
"extensions": {
"com.esri.map": {
"overlayLayers":
[
{
"ibiDataLayer": {
"map-metadata": {
"map_by_field": "
REGION"
}
}
}
],
"baseMapInfo":
{
"customBaseMaps":
[
{
"ibiBaseLayer": "gray"
}
]
}
}
}
*END
ENDSTYLE
END

The output is shown in the following image.

Adding a New Role for a Server-Hosted Map

A server-hosted map is based on a shapefile. You must upload the shapefile (.dbf) to an application folder accessible to the server. The server will transform it to ibijson format.

An ESRI shape file is actually a collection of at least four files:

  • .dbf file. The .dbf file is a standard database file used to store attribute data and object IDs. A .dbf file is mandatory for shape files.
  • .shp file. The .shp file is a mandatory Esri file that gives features their geometry. Every shapefile has its own .shp file that represents spatial vector data.
  • .shx file. The .shx file is a mandatory Esri shape index position file. This type of file is used to search forward and backwards.
  • .prj file. The .prj file is an optional file that contains the metadata associated with the shapefiles coordinate and projection system.

All files must have exactly the same name and to be located in the same directory. If they are not, the shapefile conversion will fail.

When there are several possible keys associated with a geometry, a drop down list of detected key names will be displayed. Select any one of these fields. No selection required when there is a single geometry key.

The shapefile should only be in the GCS_WGS_1984 - World Geodetic System 1984 (decimal degrees) coordinate system.

To add a geographic role for a Server-hosted map, click Add WFRS map on the Geographic Configuration Editor.

The Add WFRS hosted map dialog box opens, as shown in the following image.

Configure the following properties.

role name

Is a name for the geographic role.

Geometry type

Select either POLYGON or POINT from the drop-down list.

Esri shape

Enter the name of the application directory where the shapefile resides, or click the ellipsis (...) to navigate to the application directory. Then select the .dbf file for the role.

Load to app

Enter the name of the application directory where you want to place the ibijson file, or click the ellipsis (...) to navigate to the application directory.

Quantization type

Quantization is the process of transforming a large set of input values to a smaller set of values. When transforming the shapefile, the server will quantize points that are too close together in order to optimize map rendering performance. Two methods are available for quantization, LINEAR or GRID. The default is LINEAR.

Quantization_X

Is the threshold value for the x-axis.

Quantization_Y

Is the threshold value for the y-axis.

If the map has multiple keys, a drop-down list displays so that you can select one.

Click OK when you have finished configuring the properties.

The new role is added to the configuration as a customized role, as shown in the following image.

Click Save to save this role to the configuration.

You can test the role by right-clicking the role in the configuration editor and clicking Test. A sample map will be generated, as shown in the following image.

Adding NUTS Support

Nomenclature of territorial units for statistics (NUTS) are geographic roles specific to the European Union.

To add NUTS geographic roles to the configuration, click Add NUTS support on the Geographic Configuration Editor.

The NUTS geographic roles are added, as shown in the following image.

Click Save to save these roles to the configuration.

Adding Support for Extended Postal Codes

Click Add extended postal codes to add support for Level 1 and Level 2 postal codes used in certain countries.

Customizing Vocabulary Rules

For each geographic role, a set of vocabulary rules define how to recognize when a field name should automatically be assigned to that role. If you right-click a role, you can click Customize vocabulary from the shortcut menu.

Elements in a rule are connected by the Boolean logic operation OR (only one needs to be satisfied). Each vocabulary element contains words enclosed with special characters. Words in the rule element are connected by the Boolean logic operation AND (all need to be satisfied).

A word may be prefixed and/or suffixed with the percent character (%), which is a placeholder for any sequence of characters. If an element contains more than one word, each word has to be prefixed by the character plus (+) or minus (-). Plus indicates that the word must be found in the column name. Minus indicates that word must not be found in the column name.

For example, the following are the vocabulary rules for the role COUNTRY.

To add another rule, click Add optional.

When you are finished, click OK.

Click Save to save these rules to the configuration.

Reference: Customizing the List of Basemaps

You can edit an existing basemap definition or add a custom basemap.

Using Standard Basemaps

To add a new basemap or customize an existing basemap, select Basemap from the Object drop-down list.

Configuring Basemap Properties

The following is a description of the properties used for basemap configuration.

name

Is the name of the basemap.

Next to the name is an indicator of whether the basemap is a standard basemap or a customized basemap.

icon

Is the name of the thumbnail for the basemap (for a standard basemap) or the URL to the thumbnail (for a customized basemap) that will appear on the Basemap drop-down list in the WebFOCUS tools (for example, the Base map menu in WebFOCUS Designer) or the Change Basemap map widget.

title

Is a title to display on the Basemap drop-down list in the WebFOCUS tools or the Change Basemap map widget.

url

Is the URL to the map service that provides the basemap, for a customized basemap. The map service URL can be copied from the URL field on the page showing a custom basemap. For a standard basemap, the URL is already stored in the server geographic configuration file and is not displayed.

type

Valid values are tiled and vector.

addon_json

Specifies additional JSON properties for rendering the map.

Editing the Properties of a Basemap

To customize the properties of an existing basemap, right-click the basemap line and click Customize BASEMAP.

The Customize Basemap dialog box opens, as shown in the following image.

Edit the properties you want to change. If you change the URL, you can click Verify to make sure the map service is valid and accessible.

When you are finished, click OK, then click Save on the GEO configuration editor Basemaps page.

Adding a Custom Basemap

To add a new basemap to the configuration, click Add.

The Create a BASEMAP dialog box opens, as shown in the following image.

Enter a name for the basemap, a URL to the thumbnail, a title to display, and the URL to the map service that provides the basemap, and click Verify.

When you have configured the properties, click OK, then click Save on the GEO configuration editor Basemap page.

Reference: Customizing the List of Context Layers

To add a new context layer or customize an existing context layer, select ContextLayer from the Object drop-down list.

The following image shows the GEO configuration editor with the ContextLayer object selected.

Configuring Context Layer Properties

Following is a description of the properties used for context layer configuration.

name

Is the name of the context layer.

Next to the name is an indicator of whether the context layer is a standard context layer or a customized context layer.

authorization

Is the type of authentication needed to access this context layer. Valid values are:

  • silent. Credentials for your ArcGIS application are provided in the connection string of the Adapter for Esri ArcGIS.

    Note: For instructions for configuring the Adapter for Esri ArcGIS, see the Adapter Administration manual.

  • none. No authorization is needed.
  • named. User credentials are provided in the connection string of the Adapter for Esri.
  • on premises. User credentials for a locally hosted ArcGIS server are provided in the connection string of the Adapter for Esri.
layer type

Is the type of context layer. For a cached layer, the layer type is tile. For a layer that is rendered dynamically, the layer type is featurelayer.

title

Is a title to display on the demographic layer drop-down list in the WebFOCUS tools.

addon_json

Specifies additional JSON properties that can be used to control the rendering of the context layer. For example, smartMapping properties define the border styles within the context layer.

You no longer need to supply the addon_json property when configuring a layer. Instead, in the URI property, you can reference a layer by service URL, or by portal ID.

Depending on the type of context layer, the addon_json properties may resemble the following:

"layerObjectType" : "esri/layers/ArcGISDynamicMapServiceLayer", 
    "smartMapping": { "webMapInfo": { 
        "queryString" : "id:id", 
        "itemDataUrl" : "url", 
        "layerTypeEx" : "layerType" 
}}

where:

esri/layers/ArcGISDynamicMapServiceLayer

Defines the context layer as a dynamic map service.

id

Is the ID of the context layer on Esri ArcGIS. This can be found in the URL for the layer on the Esri ArcGIS site, or as the value of the "serviceItemId" property in the JSON properties accessible from the service URL of the layer.

If there is no layer ID, then this property can be omitted.

url

Is the map service URL for the layer. This should match the value that you provide for the uri field.

layerType

Is an optional value to specify the type of context layer. It can be one of the following values:

If your context layer is neither a group layer nor a map image layer, the layerTypeEx property is not needed.

For example, the add-on JSON for a map image layer may resemble the following:

"layerObjectType" : "esri/layers/ArcGISTiledMapServiceLayer", 
"smartMapping": { "webMapInfo": { 
    "queryString" : "id:1234567890abcdefghij1234567890ab", 
    "itemDataUrl" : 
"https://services5.arcgis.com/1234567890abcdef/arcgis/rest/services/Layer_Name/FeatureServer", 
    "layerTypeEx" : "map-image" 
    }
}
uri

Is the URL to the map service that provides the context layer.

The uri field should contain one of the following:

  • The service URL for the layer
  • If the layer does not require authentication, the portal ID for the layer, prefixed by portalid:. For example, portalid:abc123efg567
  • If the layer does require authentication, either silent or named, the portal ID for the layer, prefixed by portalid: followed by the base URL for the layer, prefixed by urlprefix:, separated by a semicolon. For example, portalid:abc123efg456;urlprefix:https://host.arcgis.com

Customizing the Properties of an Existing Context Layer

To customize the properties of an existing context layer, click the down arrow next to a context layer name or right-click the context layer line and click Customize context layer.

The Create a Custom CONTEXTLAYER dialog box opens. The completed dialog box may resemble the one shown in the following image.

Edit the properties you want to change. If you change the URI, you can click Verify to make sure the map service is valid and accessible.

When you are finished, click OK, then click Save on the GEO configuration editor Context Layers page.

Adding a New Context Layer

To add a new context layer to the configuration, click Add.

The Create a Customized CONTEXTLAYER dialog box opens, as shown in the following image.

Enter a name for the context layer, the authorization type, a layer type, a title to display, any additional JSON needed for rendering the context layer, and the URI to the map service that provides the context layer, and click Verify.

When you have configured the properties, click OK, then click Save on the GEO configuration editor Context Layer page.