Cascading Search (Productivity Kit) – VertiGIS Support

Provides a systematic way to access data, making it easier for users to navigate through large datasets and locate specific information efficiently.

This workflow uses a configurable schema to dynamically generate a form and have a cascading set of fields that query one layer.

It supports strings and numbers, and the form can contain drop-down lists and auto-complete fields. If the field is a domain field, it is recognised automatically.

Requirements

VertiGIS Studio Productivity Kit with active service subscription
Activity Pack Deployment
The deployment of Activity Packs is described in this section.

Inputs

```
schema: object array
```
The schema for the form. The following properties are included:
1. ```
layer: string
```
  The layer to be queried. Supported layer types include Feature Layers and Map
  Image Layers, as well as standalone tables. You can specify the layer using one of the following
  identifiers:
  
  layer-map-id: A unique identifier for the layer within the map. This is the recommended identifier, as it remains consistent across all Studio Web Apps using the same map. (Refer to the example below for guidance on locating this ID.
  
  layer-extension-id: A unique identifier for the layer's extension within the app.
2. ```
sublayer: string | number (optional)
```

The sublayer to be queried. You can specify the sublayer using one of the following identifiers:

sublayer-id (string): A unique identifier for the Sublayer within the layer.

subtype-code (number): The subtype code for a SubtypeSublayer. If the layer is a SubtypeGroupLayer, use this identifier to specify the sublayer. (Refer to the example below for guidance on locating this ID).

```
title: string (optional)
```
The title of the form to be display. If left empty the title element will not
be generated at all.
```
showFilter: boolean (optional)
```
Indicates whether the 'Create Filter' button will be shown or not. Defaults to 'true'.
```
fields: object array
```

An array of definitions for each field. The following properties are included:

1. ```
hierarchy: number
```
  Order of the cascading search. Must start at 0 and must increment by one for every field. The workflow will not work properly if hierarchy is not configured correctly.
2. ```
id: string
```
  Field name in the layer.
3. ```
title: string
```
  Label for the field in the workflow.
4. ```
autoComplete: boolean
```
  Indicates if it's an autocomplete (true) or a dropdown (false). Auto-Complete uses the language resource @defaultPromptText for the prompt. Autocomplete control search is case insensitive.
5. ```
minLength: number
```
  The amount of characters for an autocomplete to start suggestions. Defaults to 3.
6. ```
type: string
```
  Type of the field in the ArcGIS layer - Currently "string" and "integer" are supported. It is strongly recommended to set the type correctly. Especially if the values are being retrieved from a coded value collection and are from type integer. The values can be incorrectly evaluated in the SQL query, which results in an error and the query cannot be processed. Example intValue = '5' instead of intValue = 5.
7. ```
required: boolean 
```
  Indicates if the field is required to have a value for the workflow to finish. If a field is required, all parents above must also be required. If a field is not required, any children will ignore this configuration and will not be required.

Behaviour

The form is dynamically populated for each field. They each have a "change" event dynamically added.
Whenever a selection changes on a list, the next descendant will be activated and filled automatically.
If parents of an already selected field is changed, all children will be reset.
After click into Search the corresponding query will be triggered.

Configuration Example

Configuration Example with layer-map-id:
Configuration Example with Domain Values:

Locating the URI in Web-App JSON

To find the URI for a layer or sublayer in the VertiGIS Studio Web-App JSON, refer to the following example of a layer-extension and sublayer-extension object. You can access the Web-App JSON via the VertiGIS Item Manager or in the Web-Designer Editor by pressing Ctrl+Shift+E.

Example: Layer-Extension Object

id: Unique identifier for the layer-extension.
sublayerExtensions: Array of references to sublayer-extension objects.
layer: Contains the reference to the layer, including its unique id and title.
- id: This is the layer-map-id, a unique identifier for the layer within the map. It is the
  recommended identifier as it remains consistent across all Studio Web Apps using the same
  map.
- title: The name or title of the layer.
layerType: Specifies the type of the layer. For example, it can be ArcGISFeatureLayer, ArcGISMapServiceLayer, SubtypeGroupLayer etc.

Example: Sublayer-Extension Object

id: A unique identifier for the sublayer-extension. This ID should not be used to reference the sublayer. Instead, use the id provided within the sublayer object below.
sublayer: Contains the reference to the sublayer, including its unique id and title.
- id: This is the sublayer-code, a unique identifier for the sublayer within the layer. It is the recommended identifier as it remains consistent across all Studio Web Apps using the same map.
- title: The name or title of the sublayer.
$sublayerType: Specifies the type of the sublayer. For example, it can be "ArcGISMapServiceSublayer", "SubtypeSublayer", etc

Related to