Please enable JavaScript to view this site.

Version:

Navigation: Activities > Activity Reference

Get Layer Activity

Prev Top Next More

Description

The Get Layer activity gets a Layer from the currently selected map.

Inputs

Layer Id

Required

Type: String | Number

The ID of the layer of interest.

If the workflow will run in VertiGIS Studio Web, VertiGIS Studio Mobile, or Web AppBuilder, you can either set Layer Id to the ID from the layer object or to the layer name from the web map.

To run the workflow in the Geocortex Viewer for HTML5, set Layer Id to the map service ID if the service only has one layer. If the service has more than one layer, also set Sublayer Id to the layer ID. Get the map service ID and layer ID from Geocortex Essentials Manager or from the Geocortex Essentials Sites Directory.

In VertiGIS Studio Mobile, the Get Layer activity only accepts string values for the Layer Id input.

Sublayer Id

Optional

Type: String | Number

The ID of the sublayer of interest.

In VertiGIS Studio Mobile, the Get Layer activity only accepts string values for the Sublayer Id input.

 

Input Configuration When Using Studio Web, Studio Mobile, or ArcGIS Experience Builder

Scenario / Context

Layer Id

Sublayer Id

Individual layer added to the web map

Use the layer's title (as seen in the layer list) OR the layer's ID from the web map.

Leave blank.

Entire map service added to the web map (to get the whole service)

Use the map service's title (as seen in the layer list).

Leave blank.

A specific sublayer within a map service

Use the map service's title (as seen in the layer list).

Use the integer ID of the sublayer from the service's REST endpoint (e.g., 3).

A group layer (to get the group itself)

Use the group layer's title (as seen in the layer list).

Leave blank.

A layer inside a group layer

You must use the specific layer's ID from the web map's configuration. The layer name will not work.

Leave blank.

 

For more information, see How to configure the Get Layer activity's inputs.

Outputs

layer

Type: esri.Layer (3.x, 4.x)*

The result layer.

sublayer

Type: esri.Sublayer*

The result sublayer.

* VertiGIS Studio Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of host application. See Underlying Technologies for information.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Connectivity Requirements

This activity works when the device has intermittent connectivity to the network.

© 2025 VertiGIS North America Ltd. All Rights Reserved. | Privacy Center | Imprint
Documentation Version 5.47 (8987e945)