Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ InTouch HMI

Map provider properties

  • Last UpdatedAug 29, 2024
  • 7 minute read

The following tables list the properties you need to enter for each map data provider supported by the MapApp.

If you use a local map server to store maps from your map provider, the URL you enter for each map source should point to the map on the local server, not to the web site for the map provider.

Important: You may need to set up accounts with some map providers to be able to access the data from their servers. These map providers require an API key or a specific account when you configure map source properties.

ArcGIS

Note: To use an ArcGIS map and include x,y (latitude,longitude) and optionally z (elevation) coordinates, use the XYZ map provider. The XYZ provider is described below.

Type

Base maps and map overlays.

Source Layer

ArcGIS maps can have multiple layers. You can choose which layers of the ArcGIS map to use in this source map.

There are four Source Layer actions to select from. Select the action, then list the layers in the field to the right:

  • show: Use only the listed layers.

  • hide: Use all layers except the ones you list.

  • include: Use the default layers plus the ones you list.

  • exclude: Use the default layers, but exclude the ones you list.

To list layers, use the layer number as defined on the ArcGIS map. Separate multiple layers with a comma. For example. 1,5 specifies layers 1 and 5.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

Source URL

The URL for the ArcGIS REST service and the defined ArcGIS map you want to use. The format will be similar to this:

https://<servername>.arcgisonline.com/ArcGIS/rest/services/Specialty/<mapname>/MapServer

Opacity

For overlays only, the opacity of the overlay. A number from 0 to1 where 0 indicates 100% transparent and 1 indicates 100% opaque.

Baidu

Type

Base maps only.

Source URL

The URL for the Baidu map that you want to use as a base layer.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

Bing

Type

Base maps only.

API Key

Registered key to authenticate the MapApp to the Bing Maps server providing data.

For information about obtaining an API key, see the Microsoft Web site. At the time of writing, this was the URL:

https://www.microsoft.com/maps/create-a-bing-maps-key.aspx

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

Base sources

Base map layer types supported by Bing Maps.

  • Road: Roads within a geographic area.

  • Satellite: Orthographic aerial and satellite imagery.

  • Hybrid: Orthographic aerial and satellite imagery with overlaid roads and labels.

You can select one or more base map layer types. During run time, users can select base sources to be shown by the MapApp.

Google

Type

Base maps only.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

API Key

Registered key to authenticate the MapApp to the Google Maps server providing data.

For more information about obtaining an API key, see the Google maps platform web site. At the time of writing, the URL was:

https://developers.google.com/maps/documentation/javascript/get-api-key

Open Street Maps

Property

Description

Type

Base maps only.

Source URL

URL of the map server providing base map tiles. At the time of writing, for a street map of the entire world, you could use:

https://www.openstreetmap.org

Even though map tiles provided by Open Street Maps are free, usage restrictions apply to the OSM server at https://openstreetmaps.org. If you use the OSM base map tile server, ensure your usage is in compliance with OSM license requirements.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

WMS

WMS (the Web Map Service) does not refer to a specific map provider. Rather, it is an interface standard that is supported by multiple map providers, including the U. S. Geological Survey, ArcGIS, and many others.

Type

Base maps and map overlays.

Source URL

URL for the map you want to use. Different map sources use different URL formats; you can get the format from the map provider.

Source Layer

When making a query to retrieve tiles from a WMS server, you must specify a layer, as map provider servers support multiple layers.

If you are unsure about the layers available for a specific WMS server, you can query the available layers by entering the following URL in your browser:

<Source URL> ?request=GetCapabilities&service=WMS

This query returns an XML file listing all of the server's capabilities. Under "Capability/Layer" you will find a list of layers. Each layer has a node called "name", this is the layer name that should be specified in this property.

Custom Data

This will be sent as custom data for the WMS server.

Opacity

For overlays only, the opacity of the overlay. A number from 0 to1 where 0 indicates 100% transparent and 1 indicates 100% opaque.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

XYZ

XYZ is a function of the ArcGIS map provider to add tabular data that contains geographic locations in the form of x,y coordinates to your map. If the table also contains z-coordinates, such as elevation values, you can add tabular data as 3D content into your globe or scene. To add a table of x,y coordinates, the table must contain two fields: one for the x-coordinate and one for the y-coordinate. The values in the fields may represent any coordinate system and units, such as latitude and longitude or meters. A field for the z-coordinates that enables 3D geometry is optional.

Type

Base maps and map overlays.

Source URL

URL for your XYZ server, in a format similar to this:

https://<servername>/ArcGIS/rest/services/<mapname>/MapServer/tile/{z}/{y}/{x}

Opacity

For overlays only, the opacity of the overlay. A number from 0 to1 where 0 indicates 100% transparent and 1 indicates 100% opaque.

CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which lists named credentials of type Username and password or Domain, username and password configured in Credential Manager.

More information on few properties

Map Source API Key

API key is a unique identifier that authenticates requests associated with the map server for usage and building purposes. To avoid saving the sensitive information like API key inside the application folder, an option to select a named credential which was configured in the Credential Manager has been introduced. The API key property in the map source configuration supports a secret from Named Credentials. When typing the API key, the edit box will list named credentials of type “Secret”. You can select one of these named credentials as your API key. You will still have the option to manually specify your API key in the edit box. In runtime, the map application will read the API key information from the secure location if you have opted to use a named credential. The API key is used when making the connection to the map source.

Note: Displaying the named credentials in the API key edit box is only supported when using a standalone InTouch application.

Map Source CredentialName

The CredentialName property is for specifying a credential which represents a windows user login. This is used when a map server requires Windows authentication. The CredentialName property is a dropdown control which will list named credentials of type “Username and password” or “Domain, username and password”. For a managed InTouch application, the credentials listed will be the ones configured in the Galaxy Repository. For a standalone InTouch application, the credentials listed will be the ones configured in Application Manager. At runtime WindowViewer and the map application will retrieve the credential and use it to authenticate to a local map server.

Set local map server authentication:

  1. Install a local map server (For example: GeoServer. For more information see Set up a map server).

  2. Create a user with the username and the password matching with the user account information in your map server and grant them the necessary roles to access the maps in the local server. Use this account to authenticate accordingly in the InTouch Application Manager.

  3. Open the application in WindowMaker to see the configuration necessary.

  4. In WindowMaker open the MapApp source configuration page, at the bottom of the Industrial Graphics pane, select the Properties tab to open properties of the selected map provider.

    The corresponding properties are displayed.

  5. Specify the SourceURL to point to your local map server and also select the SourceLayer.

  6. Update the CredentialName property.

    It will display list of credentials which are available that you have created in the Credential Manager.

  7. You can also select none if you do not use a local map server that requires authentication.

  8. Open WindowViewer, and see that the MapApp has connected to the local map server and it is authenticated with the configured Named Credential.

Related Links
TitleResults for “How to create a CRG?”Also Available in