Silently Install the VertiGIS Studio Printing Toolbox

This section describes how to perform a silent installation of the VertiGIS Printing Toolbox using the install.py command-line interface.

The installer supports the following deployment types:

Prerequisites

Run the installer using a Python interpreter from an ArcGIS Pro conda environment.

Basic Usage

Use the following syntax to run the installer:

python.exe <path>\printing\Engine\v3\install.py <subcommand> <parameters>

Example:

c:\Users\<user>\AppData\Local\ESRI\conda\envs\arcgispro-py3-clone> ^

python.exe C:\<path>\printing\Engine\v3\install.py <subcommand> <parameters>

Subcommands

Portal Silent Installation

Use the portal subcommand to install the Printing Toolbox to an ArcGIS Server site federated with an ArcGIS Enterprise portal.

Example:

python.exe C:\<path>\printing\Engine\v3\install.py portal ^

--portal_url https://foo-bar.int.vertigis.com/portal ^

--oauth_token <token> ^

--service_datastore_arcgis "\\FOO-BAR\VertiGIS_PrintLayouts" ^

--service_datastore_arcgis_register False ^

--service_foldername VertiGIS_Utilities ^

--service_name VertiGIS_Printing_Tools_0_0_0_DEV_V3 ^

--python_toolbox_filename C:\<path>\printing\Engine\v3\toolbox\VertiGISPrintingTools.pyt ^

--service_arcgis_pro_layout_mode True ^

--sd_file C:\<path>\printing\Installer\Engine\deploy\sd\<federated|standalone> ^

--verify_cert True

 

Portal deployment parameters

Parameter

Default

Description

Required
--portal_url - URL of the ArcGIS Enterprise portal. Yes
--oauth_token - OAuth token used for authentication. This parameter is an alternative to --username and --password. No
--username - Portal username. Used if an OAuth token is not provided. No
--password - Portal password. Used if an OAuth token is not provided. No
--server_site_url - URL of the federated ArcGIS Server site. No
--service_arcgis_pro_layout_mode True Publishes the service using ArcGIS Pro layout mode. No
--python_toolbox_filename - Full path to the Python toolbox (.pyt). Yes
--service_datastore_arcgis "" Path to the ArcGIS datastore (for example, an SMB share used for layout resources). No
--service_datastore_arcgis_register False Specifies whether the ArcGIS datastore is registered (True or False). No
--service_foldername VertiGIS_Utilities Server folder in which the service is created. No
--service_name VertiGIS_Printing_Tools Name of the published print service. No
--sd_file "" Path to the service definition (.sd) file. No
--verify_cert True Verifies SSL certificates when connecting to the portal. No

 

Standalone Silent Installation

Use the standalone subcommand to install the Printing Toolbox to a standalone ArcGIS Server site.

Example:

python.exe C:\<path>\printing\Engine\v3\install.py standalone ^

--server_connection_file C:\connections\server.ags ^

--python_toolbox_filename C:\<path>\printing\Engine\v3\toolbox\VertiGISPrintingTools.pyt ^

--service_datastore_arcgis "\\FOO-BAR\VertiGIS_PrintLayouts" ^

--service_datastore_arcgis_register False ^

--service_foldername VertiGIS_Utilities ^

--service_name VertiGIS_Printing_Tools ^

--sd_file C:\<path>\printing\Installer\Engine\deploy\sd\standalone ^

--verify_cert False

Standalone deployment parameters

Parameter

Default

Description

Required
--server_connection_file - Path to the ArcGIS Server connection file (.ags). Yes
--python_toolbox_filename - Full path to the Python toolbox (.pyt). Yes
--service_datastore_arcgis "" Path to the ArcGIS datastore (for example, an SMB share used for layout resources). No
--service_datastore_arcgis_register False Specifies whether the ArcGIS datastore is registered (True or False). No
--service_foldername VertiGIS_Utilities Server folder in which the service is created. No
--service_name VertiGIS_Printing_Tools Name of the published print service. No
--sd_file "" Path to the service definition (.sd) file. No
--verify_cert True Verifies SSL certificates when connecting to the server. No

Additional Considerations

SSL Certificate Verification

When verify_cert is set to True, the installer requires a valid SSL certificate for all requests, including service publishing and post-publish verification.

When set to False, SSL certificate validation is skipped. A security warning is displayed during publishing, but the installation continues.

Disabling SSL certificate verification is a security risk and should only be used in trusted environments.

Integrated Windows Authentication

If the ArcGIS Enterprise portal or standalone ArcGIS Server is configured for Integrated Windows Authentication, the following parameters can be omitted:

ArcGIS Pro Layout Mode

When service_arcgis_pro_layout_mode is set to True, the deployed Printing Service can be discovered by VertiGIS Studio components that search for an ArcGIS Pro-based Printing Engine.