Printing vertigis.arcgis.printing
Network Locator uses the VertiGIS Printing Engine for generating the PDF outputs (see the documentation for the VertiGIS Studio Printing Engine). For asynchronous execution, the Process Manager service POSTs the job request to the corresponding GPService endpoint and requests the current job status on a regular basis, until the Job finished.
There are several settings to configure how Network Locator communicates with the Printing engine.
GpServiceConfig
Setting |
Type |
Description |
service-url |
String [Required] |
The absolute URL to the VertiGIS Printing GpService REST endpoint The URL must be accessible via HTTPS using a trusted certificate. Self-signed certificates are not supported. |
initialize-templates |
Boolean |
If set to true, templates will be queried upon application start up. Otherwise they will be queried the first time they are needed. |
templates |
This section displays the complete list of print templates available in the application. You can later define subsets of this list when configuring the print-templates config roles for individual user groups. |
|
max-parallel-tasks |
Int |
The maximum number of parallel executions of GPTasks on this Instance. Default: 10 |
printing.cache-template-duration |
Duration |
The duration, the print templates and packages will be cached, and no requests to the Get Layout Templates Info Task endpoint will be done. If set to 0 items will be cached indefinitely. If null, caching will be disabled. Default: "1h" |
loadAllLocalTemplates |
Boolean |
Default: true |
tasks |
This section lets you overwrite settings of a specific underlying GP Service Task |
GpTaskConfig
Setting |
Type |
Description |
validation |
This setting allows to overwrite the default validation settings for the printing engine |
|
max-parallel-tasks |
Int |
The maximum number of parallel executions of GPTasks on this Instance. Default: 10 |
retries |
Int |
The max number of retries of a GPJob poll. Default: 3 |
timeout |
Duration |
The timeout of the GpTask. Default: 10 Minutes |
ValidationConfig
Setting |
Type |
Description |
debug |
Boolean |
Whether the printing task is executed with debug mode. |
strict |
Boolean |
Indicates whether the printing task is executed in strict mode. In strict mode, additional validations are performed after printing to ensure that all required data is included in the output. Default: True |
TemplatesConfig
Setting |
Type |
Description |
templates.loadAllLocalTemplates |
Boolean [Optional] |
If true, all local templates will be added to the template list, additionally to the configured templates. Default: true |
templates.templates |
TemplateConfig [Optional] |
The Portal Layout Templates to be used |
TemplateConfig
Setting |
Type |
Description |
templates.<name> |
String [Required] |
Name of the template |
templates.<name>.id |
String [Required] |
The print template or package item id of the print package. (starting with vglay or vglaypk) |
templates.<name>.portal |
String [Optional] |
Which portal should be used to query for the Print Layout (if not set the default portal will be used). |
Sample Config
"vertigis": {
"arcgis": {
"printing": {
"tasks": {
"VertiGIS Print Task": {
"validation": {"debug": false,"strict": false}
}
}
"service-url": "<ARCGIS-SERVER-BASE-URL>/server/rest/services/Network_Locator/VertiGIS_Printing_Tools/GPServer",
"execution-type": "ASYNCHRONOUS",
"timeout": "15m",
"retries": 5,
"max-parallel-tasks": 4,
"cache-template-duration": "1h",
"templates": {
"load-all-local-templates": false,
"templates": {
"A4 Quer": {
"id": "vglaypk_c03d6eb733bf4eb8834cf8b2c0520c07"
},
"A4 Hoch": {
"id": "vglaypk_c03d6ebasda876asdas8hsaklaiz876a"
}
}
},
"initialize-templates": true
},
"server": {
"server1": {
"server-url": "https://<ARCGIS-SERVER-BASE-URL>/server/rest"
}
}
}.
ArcGIS Server vertigis.arcgis.server
Setting |
Type |
Description |
enabled |
Boolean [Optional] |
Default: true |
server-url |
String [Required] |
The absolute URL to the ArcGIS Server REST Api The URL must be accessible via HTTPS using a trusted certificate. Self-signed certificates are not supported. |
generate-token-url |
String [Optional] |
The relative path or absolute URL of the 'generateToken' endpoint (optional) |
credentials |
<CredentialsConfig> [Optional] |
The credentials used to connect with if any secured resources are accessed |
initial-connection-timeout |
Duration [Optional] |
The maximum amount of time connecting to the currently unavailable ArcGIS Server will be attempted for. |
connection-timeout |
String [Optional] |
The amount of time after which the current ArcGIS Server connection request will time out. |
connection-retry-count |
Int [Optional] |
The number of times an attempt to re-establish an already available connection will be repeated for. Default: "10" |
token-settings |
TokenConfig [Optional] |
The ArcGIS Server token settings |
proxy |
ProxyConfig [Optional] |
The proxy configuration |
Sample config
"vertigis": {
"arcgis": {
"server": {
"<ID>": {
"server-url": "https://<ARCGIS-SERVER-BASE-URL>/server/rest",
"enabled": true,
"generate-token-url": "",
"credentials": {
"username": "",
"password": {
"value": "",
"provider": {
"name": "",
"key": ""
},
"method": "POST"
}
},
"connection-timeout": "10s",
"connection-retry-count": 3,
"token-settings": {
"early-token-acquisition": true,
"token-client-type": "REFERER",
"referer": "network-locator",
"token-expiration": "60M",
"refresh-token-time-skew": "10s"
},
"proxy": {
"host": "https://proxy.com",
"port": 443,
"credentials": {
"username": "",
"password": {
"value": "",
"provider": {
"name": "",
"key": ""
},
"method": "POST"
}
}
}
}
}
}
}
DXF Export vertigis.arcgis.dxf-export
Setting |
Type |
Description |
exclude-logs |
Boolean [Optional] |
Default: true |
