Please enable JavaScript to view this site.

Version:

Navigation: Configuration > Web Services Configuration > Process Manager

Process Manager Configuration

Prev Top Next More

Network Locator vertigis.network-locator.process-manager

Setting

Type

Description

vertigis.network-locator.[default|role].process-manager.admin-mail-addresses

List<String>

 [Required]

Mail addresses of people that will be notified if a request runs into an error.

The E-Mail Template of type "error-admin" will be used for the mail

Example: "admin1@evu.de,admin2@evu.de"

vertigis.network-locator.[default|role].process-manager.agent-mail-addresses

List<String>

Mail addresses of people that will be notified if a request intersects a locked area.

Example: "agent1@evu.de,agent2@evu.de"

vertigis.network-locator.[default|role].request-restrictions.max-num-pages

int

 [Optional]

The maximum number of print pages allowed per individual request.

Default: 10

vertigis.network-locator.[default|role].request-restrictions.max-num-requests-per-day

int

 [Optional]

The maximum number of requests allowed per user in a single day.

Default: 10

vertigis.network-locator.[default|role].request-restrictions.max-request-area

int

[Optional]

Defines the upper limit of the request area size, measured in square meters (m²). Requests exceeding this size will be rejected.

Default: 50000

vertigis.network-locator.[default|role].zip-file-name

String

 [Required]

The name pattern that the request zip file should get

Default: "result_{request_id}"

vertigis.network-locator.[default|role].use-print-pages-for-intersection

Boolean

[Optional]

If set, the geometry of the print pages will be used for intersection calculation, otherwise, the input geometry will be used.

Default: true

vertigis.network-locator.[default|role].static-files

List<StaticFiles>

[Optional]

A list of files that should be added to the request artefact

vertigis.network-locator.[default|role].intersection-groups

IntersectionLayerGroupsConfig

[Required]

Configuration of the intersection groups (branches) used by the network-locator process-manager.

vertigis.network-locator.[default|role].negative-reply-templates

NegativeReplyTemplatesConfig

[Required]


vertigis.network-locator.[default|role].mail-templates

MailTemplatesConfig

[Required]


vertigis.network-locator.[default|role].dynamic-document-templates

DynamicDocumentTemplatesConfig

[Optional]


 

Sample

"process-manager": {
         "request-restrictions": {
           "max-num-pages": 10,
           "max-num-requests-per-day": 200
         },
         "admin-mail-addresses": "admin@vertigis.com",
         "dynamic-document-templates": [
           {
             "pdf-file-name": "Niederschrift",
             "template-file-id": "locator-templates@dynamic-document@letter.fo.qute"
           },
           {
             "template-file-id": "locator-templates@dynamic-document@Niederschrift-Neu",
             "pdf-file-name": "Niederschrift-Neu"
           },
           {
             "template-file-id": "locator-templates@dynamic-document@letterQA-test.fo.qute",
             "pdf-file-name": "letterQA-test"
           }
         ],
         "intersection-groups": {
           "electricity": {
             "display-name": "Stromnetz",
             "print-output": {
               "file-name": "Strom",
               "detail": {
                 "web-map-id": "3542d928bbd6414a8f282350d7591242",
                 "dynamic-print-elements": {
                   "sparte": "Strom"
                 }
               },
               "overview": {
                 "web-map-id": "3542d928bbd6414a8f282350d7591242"
               }
             },
             "layers": {
               "subnet-line": {
                 "buffer-size": "10.0",
                 "display-name": "Line",
                 "layer-url": "https://<AGS-BASE-URL>/server/rest/services/Berlin_postgres_108/Berlin_postgres_108/FeatureServer/4"
               }
             }
           },
           "gas": {
             "display-name": "Gasnetz",
             "print-output": {
               "file-name": "Gas",
               "detail": {
                 "web-map-id": "1163d935c8354b15b57e0f006d63289d",
                 "dynamic-print-elements": {
                   "sparte": "Gas"
                 }
               },
               "overview": {
                 "web-map-id": "3542d928bbd6414a8f282350d7591242"
               }
             },
             "layers": {
               "subnet-line": {
                 "buffer-size": "10.0",
                 "display-name": "Subnet-Line",
                 "layer-url": "https://<AGS-BASE-URL>/server/rest/services/Berlin_postgres_108/Berlin_postgres_108/FeatureServer/9"
               }
             }
           },
           "water": {
             "display-name": "Wassernetz",
             "print-output": {
               "file-name": "Wasser",
               "detail": {
                 "web-map-id": "be6f2f65b19c47daa99dfec527f8580b",
                 "dynamic-print-elements": {
                   "sparte": "Wasser"
                 }
               },
               "overview": {
                 "web-map-id": "3542d928bbd6414a8f282350d7591242"
               }
             },
             "layers": {
               "subnet-line": {
                 "buffer-size": "10.0",
                 "display-name": "Line",
                 "layer-url": "https:/<AGS-BASE-URL>/server/rest/services/Berlin_postgres_108/Berlin_postgres_108/FeatureServer/17"
               }
             }
           }
         },
         "mail-templates": {
           "storage-service-url": "https://<KUBERNETES-BASE-URL>/api-network-locator-gateway/storage/file",
           "templates": {
             "error": {
               "subject": "[Network Locator] Planauskunft Error{#if request_id??} - {request_id}{/if}",
               "file-id": "locator-templates@mail@requestError.html"
             },
             "error-admin": {
               "subject": "[Network Locator] Planauskunft Error Admin{#if request_id??} - {request_id}{/if}",
               "file-id": "locator-templates@mail@requestErrorAdmin.html"
             },
             "no-result": {
               "file-id": "locator-templates@mail@requestSuccessNoResult.html",
               "subject": "[Network Locator] Planauskunft - {request_id}"
             },
             "success": {
               "file-id": "locator-templates@mail@requestSuccess.html",
               "subject": "[Network Locator] Planauskunft - {request_id}"
             }
           }
         },
         "zip-file-name": "result_{request_id}",
         "static-files": [
           {
             "file-id": "locator-documents@static@2023_05_24_Benutzerdokumentation_OnlinePlanauskunft.pdf",
             "file-name": "2023_05_24_Benutzerdokumentation_OnlinePlanauskunft.pdf"
           }
         ],
         "negative-reply-templates": {
           "per-group": {
             "template-file-id": "locator-templates@negative-reply@negative-reply-per-group.fo.qute",
             "pdf-file-name": "Negative_Reply_{in_group}"
           }
         }
       }

 

vertigis.network-locator.intersection-groups

Network Locator can be configured to produce map documents for multiple branches. In the configuration these are called intersection-groups.

IntersectionLayerGroupsConfig

Setting

Type

Description

layers

IntersectionLayerConfig

[Required]

Contains all intersection layers configured in this group.

display-name

String

[Optional]

Display name of this layer group.

print-output

LayerGroupPrintOutputConfig

[Optional]

The intersection group output configuration.

static-Files

NetworkLocatorProcessManagerConfig.StaticFile

[Optional]

 

enabled

Boolean

[Optional]

Enables/Disables the whole intersection group.

Default: true

 

IntersectionLayerConfig

Setting

Type

Description

layer-url

String

[Required]

The absolute URL to the ArcGIS Feature Service Layer.

layer-filter

String

[Optional]

filter that will be used for querying the ArcGIS Feature Service layer.

display-name

String

[Optional]

display name of this layer.

server

String

[Optional]

If not configured the ArcGIS Server will automatically be retrieved using the layer-url parameter.

buffer-size

Double

[Optional]

Buffer, that will be used when querying the ArcGIS Feature Service layer.

fields

List<String>

[Optional]

Fields of the ArcGIS FeatureServiceLayer that should be fetched in the query. Applies only if return-featuers is true

show-in-map

Boolean

[Optional]

Specifies whether the layer should be visible on the map or used solely for background intersection processing.

Default: false

dynamic-print-elements

<key> <string>

 [Optional]

Allows you to define additional print elements for use in the ArcGIS Pro Print Template. These elements are only passed to the print engine if the layer is intersected by the request area.

return-features

Boolean

[Optional]

Specifies whether the query should return only a count or include the features within the requested area.

Default: false

type

String

[Optional]

Defines the type of layer. Can be either of the following values

AUTOMATIC: Intersections with this layer will result in automatic request processing

LOCKED_AREA: Intersections with this layer will trigger a notification to internal agents, who must review the request. Layers of this type can define the agent-mail-addresses property if you want to overwrite the global agent-mail-addresses setting

"Sperrflächen": {
"buffer-size": "0.1",
"display-name": "Hochspannung",
"layer-url": "https://<HOST>/server/rest/services/Hosted/Locator_Locked_Areas/FeatureServer/0",
"layer-filter": "objectid = 1",
"type": "LOCKED_AREA",
"show-in-map": true,
"agent-mail-addresses": "agent@vertigis.com"
}

PROHIBITED_AREA: Intersections with this layer will trigger a notification to the user and block the request from being executed.

DOCUMENT: When this layer is intersected by the request area, the system searches for features within that area and attempts to load any images attached to those features. The images are retrieved using the doc-url property, which supports dynamic references to feature attributes.

"documents": {
"layer-url": "https://<HOST>/server/rest/services/Berlin_postgres/Berlin_postgres/FeatureServer/5",
"layer-filter": "documentname IS NOT NULL",
"doc-url": "https://documentsbaseurl/{feature.documentfolder}/{feature.documentname}",
"buffer-size": "5.0",
"type": "DOCUMENT"
}

MAIL: Intersections with this layer will trigger an additional Mail. The content and the look and feel of the mail is defined in the custom mail template which is referenced in the property mail-template-key. You can reference values from the feature if the mail adresses are stored at the feature level. Following additional properties are available for layer of type MAIL:

"email-hochspannung": {
"layer-url": "https://<HOST>/server/rest/services/Berlin_postgres/Berlin_postgres/FeatureServer/8",
"display-name": "MAIL",
"type": "MAIL",
"mail-to-recipients": "hochspannung@vertigis.com",
"mail-template-key": "additional-mail-template-name",
"mail-bcc-recipients": "moremails@vertigis.com, {feature.<attribute-that-contains-mail-address>}",
"mail-cc-recipients": "evenmoremails@vertigis.com"
}

 

 

 

 

NegativeReplyTemplatesConfig

Setting

Type

Description

per-group

DynamicFile

 

DynamicFile

Setting

Type

Description

template-file-id

String

File ID of the negative reply template

pdf-file-name

String

File name of the PDF that contains the negative reply.

It is recommended to add the variable {in_group} to the file name so that every intersection group get a unique file name. (See Sample)

 

MailTemplatesConfig

Setting

Type

Description

templates

MailTemplateConfig

 

MailTemplateConfig

Setting

Type

Description

file-id

String

File ID of the mail  template

subject

String

The mail template subject.

 

DynamicDocumentTemplatesConfig

Setting

Type

Description

templates

DynamicFile

 

 

DynamicFile

Setting

Type

Description

template-file-Id

String

File ID of the dynamic document  template

pdf-file-name

String

File name of the generated PDF file

© 2025 VertiGIS North America Ltd. All Rights Reserved. | Privacy Center | Imprint
Documentation Version 1.6 (cb599c32)