Octopus Deploy variable information for Document Generation Services installation

OD Variable Name	Description
ALLOW_XPATH_1	Indicates whether XPath 1.0 compatibility mode is allowed. If false (0), then XPath Compatibility Mode is turned off and transactions will fail if duplicate transaction data exists. If true* (1), then XPath Compatibility Mode is turned on and transactions generate successfully if duplicate transaction data exists; *"true" is the default value blank or not included: then XPath Compatibility Mode defaults to the value set in `BSI.Properties > com.bankerssystems.expere.xPath_1_0_Compatibility`
ClientParameters_ezConfig_ClientSecrets	The thumbprint for the WKFS.EZ.PackagePackets certificate
ClientParameters_ezDefaultDataClient_ClientSecrets	The thumbprint for the WKFS.EZ.DefaultData certificate
ClientParameters_STSAdministration_ClientSecrets	The thumbprint for the WKFS.STSv3.Administration certificate
ClientParameters_stsTestClient_ClientSecrets	The thumbprint for the WKFS.STSv3.Tests certificate
ClientParameters_ApiSecrets_STSApiSharedSecret_SecretPlainText	The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.
ClientParameters_ApiSecrets_STSApiSharedSecret_SecretValue	SecretValue base-64 encoded with padded and is seeded into the STS config database for a given client
ClientParameters_ApiSecrets_EdsSharedSecret_SecretPlainText	The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.
ClientParameters_ApiSecrets_EdsSharedSecret_SecretValue	SecretValue base-64 encoded with padded and is seeded into the EDS database for a given client
ClientParameters_ApiSecrets_DGSCoreApi_SecretPlainText	The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.
ClientParameters_ApiSecrets_DGSCoreApi_SecretValue	SecretValue base-64 encoded with padded and is seeded into the STS database for a given client
ClientParameters_ApiSecrets_EZConfigPackagesAndPacketsSharedSecret_SecretValue	SecretValue base-64 encoded with padded for EZ Config Packages and Packets API resource and is seeded into the STS config database for a given client
ClientParameters_ApiSecrets_EZConfigDefaultDataSharedSecret_SecretValue	SecretValue base-64 encoded with padded for EZ Config Default Data API resource and is seeded into the STS config database for a given client
ClientParameters_ezDGSDefaultDataClient_ClientSharedSecretsPlainText	The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.
ClientParameters_ezDGSDefaultDataClient_ClientSharedSecrets	The thumbprint for the EZ Config Default Data certificate
ClientParameters_ezConfigClient_ClientSharedSecretsPlainText	The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.
ClientParameters_ezConfigClient_ClientSharedSecrets	The thumbprint for the EZ Config Client certificate
DBName	The name of the Expere database
DBServer	The hostname of the database hosting the Expere database
DGSDB_TokenCacheDBName	Allows for the AppSecurityTokenCache database name to be renamed, which creates a database with a name other than the default.
DefaultDataDBAppUsers	This property is the SQL Login Username used by the application to access the database. If running as a Network Service, this will be the machine account for the server hosting Default Data Application and multiple machine accounts can be specified. Syntax for Single Domain/User: -AppUsers "DOMAIN\DGS-CI-SRVC" Syntax for Multiple Machine Accounts (each Machine Account must be separated using the Pipe ( \| ) delimiter): -AppUsers "DOMAIN\MACHINENAME1$\|DOMAIN\MACHINENAME2$"
DefaultDataDBDebug	This property controls whether or not debug information is provided during script processing. true = displays debug information during script processing. null/false = (default) debug information does not display during script processing.
DefaultDataDBDrop	Property to indicate whether to drop the database prior to installing the new database. true-will drop the database null/false – (default) will not drop the database
DefaultDataDBLogin	Property to define the SQL user that the script will use to connect to SQL Server when installing the Default Data DB. If using Windows Authentication, this parameter should not be included.
DefaultDataDBName	Property that defines the name of the database. Note: This value needs to also be specified in the Transform file for the application installation.
DefaultDataDBPassword	Property to define the password for SQL user that the script will use to connect to SQL Server when installing the Default Data DB. If using Windows Authentication, this parameter should not be included.
DefaultDataDBServer	This property is the name of the SQL Server Name that will host the Default Data Database. NOTE: Must include Instance name in the value if applicable.
DefaultDataTransformVar	The transform file for Default Data application install
DGSCoreDocViewerTransformVar	The transform file for DGSCoreDV application install
DGSCoreTransformVar	The transform file for DGSCore application install
DGSDB_Account	If you are using a service account for DGS services/app pools, you can use this variable to give the account access to the DocGen database
DGSDB_DatabaseServer	The database server hostname that hosts the DGS database
DGSDB_DatabaseName	The name of the DGS database. DocGen is the default is this is omitted
DGSInstallFeatures	This is used to control which DGS feature is installed on the server (DocGenServices, Management, or both). Values can be ALL, DGS, Management
DGSTransformVar	The transform file for DGS application install
DocumentServiceTransformVar	The DocumentService transform
DOCVIEWER_ENVIRONMENT	The transform category for the DocViewer install
DocViewerTransformVar	The transform file for DV application install
DOMAINACCOUNT	If RUNASSERVICEACCT=1, ACCOUNTDOMAIN, DOMAINACCOUNT, and DOMAINACCOUNTPASSWORD will be used to to create the account to run the DGS services
EDSDB_Account	The account to give permission to the EDS DB
EDSDB_DatabaseName	DocServices
EDSDB_DatabaseServer	DB server name
EDSDB_InstallFeatures	A comma separated list of values Database,Permissions,TokenStore Database: creates/updates the database schema Permissions: If provided, the script will grant db_owner to the "EDSDB_Account" TokenStore: creates the EDSSecurityTokenStore table in the AppSecurityTokenCache DB; used to store tokens in a load-balanced environment
EDSDB_TokenCacheDBName	Allows for the AppSecurityTokenCache database name to be renamed, which creates a database with a name other than the default.
EDSToolSuiteTransformVar	Transform variable for installing the Expere Document Services Tool Suite
EDSTransformVar	EDS transform
ExpereTransformVar	The transform file for Expere application install
expereUrl	The Expere end point URL, defaults to and would usually be… http://localhost:8080/Common/WSEndpoint
EzConfigServiceClientId	The client id created in STS Account
EzConfigServiceClientScopes	The scopes for the provided Client Id, most likely should be… wk-ezcfg-def-data-su wk-ezcfg-pkg-pkt-su wk-dgs-core-su
EzConfigServiceClientSecret	The base64 encoded client certificate
EzConfigServiceConnectionType	If the database connection will be trusted or not. Defaults to True
EzConfigServiceDbHostName	The database server hostname that hosts the database
EzConfigServiceDefaultDataDbName	The name of the Default Data database
EzConfigServiceDgsHostName	The database server hostname that hosts the DGS database
EzConfigServiceHealtCheckUrl	The health check URL for the Repost service, defaults to… http://localhost:30948
EzConfigServicePkgPktDbName	The name of the Packages and Packets database
EzConfigServiceRepostsQueueName	The name of the Rabbit queue for the repost service, defaults to reposts
EzConfigServiceConversionsQueueName	The name of the Rabbit queue for the conversion service, defaults to conversions
EzConfigServiceRabbitMQHost	The hostname of the Rabbit server, defaults to localhost
EZGatewayTransformVar	The transform file for EZGateway application install
OctopusMsiTransformCategory	The transform category for all application installs (except Docviewer)
PKGPKTDBAppUsers	This property is the SQL Login Username used by the application to access the database. If running as a Network Service, this will be the machine account for the server hosting Packages and Packets Application and multiple machine accounts can be specified. Syntax for Single Domain/User: -AppUsers "DOMAIN\DGS-CI-SRVC" Syntax for Multiple Machine Accounts (each Machine Account must be separated using the Pipe ( \| ) delimiter): -AppUsers "DOMAIN\MACHINENAME1$\|DOMAIN\MACHINENAME2$"
PKGPKTDBDrop	Property to indicate whether to drop the database prior to installing the new database. true-will drop the database null/false – (default) will not drop the database
PKGPKTDBName	Property that defines the name of the database. Note: This value needs to also be specified in the Transform file for the application installation.
PKGPKTDBServer	This property is the name of the SQL Server Name that will host the Packages and Packets Database. NOTE: Must include Instance name in the value if applicable.
PKGPKTTransformVar	The transform file for Packages and Packets application install
STS_DB_Mapping_AdminHostname	The hostname of the STSAdmin application
STS_DB_Mapping_AppUsers	The list of users that will be granted access to the STS databases
STS_DB_Mapping_DBServer	The hostname of the database server hosting the STS databases
STS_DB_Mapping_DevSwitch	Keep true if you want all the default certificates installed and some other basic setup done.
STS_DB_Mapping_DGSHostname	The name of the database server hosting the DGS databases
STS_DB_Mapping_DropDatabases	If true, existing databases will be dropped and re-created
STS_DB_Mapping_EDSHostname	The name of the server hosting EDS
STS_DB_Mapping_EZConfigHostname	The hostname of the database server hosting the EZConfig databases
STS_DB_Mapping_GenerateIds	Consider your usage. If false, STSv3 will need to communicate to CoreServices to get IDs for new objects. If you are planning testing migration scenarios, leaving this as false is a good option. This also means you’ll need to modify your CoreServices install
STS_DB_Mapping_HideLegacyProducts	Keep false if you want all legacy apps to appear in STSv3.
STS_DB_Mapping_Hostname	The hostname of the STS application
STS_DB_Mapping_MigrateOspreyAccounts	Setting this to true will migrate accounts, users, roles, etc. from CoreServices to STSv3.
STS_DB_Mapping_MigrateOspreyApp	Setting this to true will migrate the admin1 user from CoreServices to STSv3.
STS_DB_Mapping_STSConfigDB	The name of the STS database. STSConfiguration is the default is this is omitted
STS_DB_Mapping_STSConfigV4DB	The name of the STS database. STSConfigurationV4 is the default is this is omitted
STS_DB_Mapping_STSAuthDB	The name of the STS database. STSAuth is the default is this is omitted
STS_DB_Mapping_WebHelpHostName
STS_DB_UseMappings	Required to set. If this is not set to true, the custom CI install will not happen and you will get a whole bunch of default values everywhere
STSHost	The HTTPS URL to STS application https://hostname
STSv3TransformVar	The transform file for STS application install
UsingBlobStorage	A boolean indicator; a "true" value indicates that BLOB storage is used for PDF and transaction data. By default, this value is set to "false".
BlobStorageAccountName	Part of the connection string; configured as part of storage account creation.
BlobStorageAccountKey	Part of the connection string; configured as part of storage account creation.
BlobStorageEndpointSuffix	Part of the connection string; configured as part of storage account creation.
BlobStorageContainerName	Part of the connection string; configured as part of storage account creation.
BlobStorageRetryCount	Sets the number of transaction retries that can occur to BLOB storage before a transaction fails. The default setting is "5".
BlobStorageRetryDelayMs	Sets the interval (in milliseconds) between transaction retries that can occur to BLOB storage. The default setting is "1000".

ALLOW_XPATH_1

Indicates whether XPath 1.0 compatibility mode is allowed.

If false (0), then XPath Compatibility Mode is turned off and transactions will fail if duplicate transaction data exists.
If true* (1), then XPath Compatibility Mode is turned on and transactions generate successfully if duplicate transaction data exists; *"true" is the default value
blank or not included: then XPath Compatibility Mode defaults to the value set in BSI.Properties > com.bankerssystems.expere.xPath_1_0_Compatibility

ClientParameters_ezConfig_ClientSecrets

The thumbprint for the WKFS.EZ.PackagePackets certificate

ClientParameters_ezDefaultDataClient_ClientSecrets

The thumbprint for the WKFS.EZ.DefaultData certificate

ClientParameters_STSAdministration_ClientSecrets

The thumbprint for the WKFS.STSv3.Administration certificate

ClientParameters_stsTestClient_ClientSecrets

The thumbprint for the WKFS.STSv3.Tests certificate

ClientParameters_ApiSecrets_STSApiSharedSecret_SecretPlainText

The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.

ClientParameters_ApiSecrets_STSApiSharedSecret_SecretValue

SecretValue base-64 encoded with padded and is seeded into the STS config database for a given client

ClientParameters_ApiSecrets_EdsSharedSecret_SecretPlainText

The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.

ClientParameters_ApiSecrets_EdsSharedSecret_SecretValue

SecretValue base-64 encoded with padded and is seeded into the EDS database for a given client

ClientParameters_ApiSecrets_DGSCoreApi_SecretPlainText

The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.

ClientParameters_ApiSecrets_DGSCoreApi_SecretValue

SecretValue base-64 encoded with padded and is seeded into the STS database for a given client

ClientParameters_ApiSecrets_EZConfigPackagesAndPacketsSharedSecret_SecretValue

SecretValue base-64 encoded with padded for EZ Config Packages and Packets API resource and is seeded into the STS config database for a given client

ClientParameters_ApiSecrets_EZConfigDefaultDataSharedSecret_SecretValue

SecretValue base-64 encoded with padded for EZ Config Default Data API resource and is seeded into the STS config database for a given client

ClientParameters_ezDGSDefaultDataClient_ClientSharedSecretsPlainText

The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.

ClientParameters_ezDGSDefaultDataClient_ClientSharedSecrets

The thumbprint for the EZ Config Default Data certificate

ClientParameters_ezConfigClient_ClientSharedSecretsPlainText

The client owner uses the ...SecretPlainText value to authenticate the client with STS; that value is usually stored in the web.config or appsettings.json.

ClientParameters_ezConfigClient_ClientSharedSecrets

The thumbprint for the EZ Config Client certificate

DBName

The name of the Expere database

DBServer

The hostname of the database hosting the Expere database

DGSDB_TokenCacheDBName

Allows for the AppSecurityTokenCache database name to be renamed, which creates a database with a name other than the default.

DefaultDataDBAppUsers

This property is the SQL Login Username used by the application to access the database. If running as a Network Service, this will be the machine account for the server hosting Default Data Application and multiple machine accounts can be specified. Syntax for Single Domain/User: -AppUsers "DOMAIN\DGS-CI-SRVC" Syntax for Multiple Machine Accounts (each Machine Account must be separated using the Pipe ( | ) delimiter): -AppUsers "DOMAIN\MACHINENAME1$|DOMAIN\MACHINENAME2$"

DefaultDataDBDebug

This property controls whether or not debug information is provided during script processing. true = displays debug information during script processing. null/false = (default) debug information does not display during script processing.

DefaultDataDBDrop

Property to indicate whether to drop the database prior to installing the new database. true-will drop the database null/false – (default) will not drop the database

DefaultDataDBLogin

Property to define the SQL user that the script will use to connect to SQL Server when installing the Default Data DB. If using Windows Authentication, this parameter should not be included.

DefaultDataDBName

Property that defines the name of the database. Note: This value needs to also be specified in the Transform file for the application installation.

DefaultDataDBPassword

Property to define the password for SQL user that the script will use to connect to SQL Server when installing the Default Data DB. If using Windows Authentication, this parameter should not be included.

DefaultDataDBServer

This property is the name of the SQL Server Name that will host the Default Data Database. NOTE: Must include Instance name in the value if applicable.

DefaultDataTransformVar

The transform file for Default Data application install

DGSCoreDocViewerTransformVar

The transform file for DGSCoreDV application install

DGSCoreTransformVar

The transform file for DGSCore application install

DGSDB_Account

If you are using a service account for DGS services/app pools, you can use this variable to give the account access to the DocGen database

DGSDB_DatabaseServer

The database server hostname that hosts the DGS database

DGSDB_DatabaseName

The name of the DGS database. DocGen is the default is this is omitted

DGSInstallFeatures

This is used to control which DGS feature is installed on the server (DocGenServices, Management, or both). Values can be ALL, DGS, Management

DGSTransformVar

The transform file for DGS application install

DocumentServiceTransformVar

The DocumentService transform

DOCVIEWER_ENVIRONMENT

The transform category for the DocViewer install

DocViewerTransformVar

The transform file for DV application install

DOMAINACCOUNT

If RUNASSERVICEACCT=1, ACCOUNTDOMAIN, DOMAINACCOUNT, and DOMAINACCOUNTPASSWORD will be used to to create the account to run the DGS services

EDSDB_Account

The account to give permission to the EDS DB

EDSDB_DatabaseName

DocServices

EDSDB_DatabaseServer

DB server name

EDSDB_InstallFeatures

A comma separated list of values Database,Permissions,TokenStore

Database: creates/updates the database schema
Permissions: If provided, the script will grant db_owner to the "EDSDB_Account"
TokenStore: creates the EDSSecurityTokenStore table in the AppSecurityTokenCache DB; used to store tokens in a load-balanced environment

EDSDB_TokenCacheDBName

Allows for the AppSecurityTokenCache database name to be renamed, which creates a database with a name other than the default.

EDSToolSuiteTransformVar

Transform variable for installing the Expere Document Services Tool Suite

EDSTransformVar

EDS transform

ExpereTransformVar

The transform file for Expere application install

expereUrl

The Expere end point URL, defaults to and would usually be… http://localhost:8080/Common/WSEndpoint

EzConfigServiceClientId

The client id created in STS Account

EzConfigServiceClientScopes

The scopes for the provided Client Id, most likely should be… wk-ezcfg-def-data-su wk-ezcfg-pkg-pkt-su wk-dgs-core-su

EzConfigServiceClientSecret

The base64 encoded client certificate

EzConfigServiceConnectionType

If the database connection will be trusted or not. Defaults to True

EzConfigServiceDbHostName

The database server hostname that hosts the database

EzConfigServiceDefaultDataDbName

The name of the Default Data database

EzConfigServiceDgsHostName

The database server hostname that hosts the DGS database

EzConfigServiceHealtCheckUrl

The health check URL for the Repost service, defaults to… http://localhost:30948

EzConfigServicePkgPktDbName

The name of the Packages and Packets database

EzConfigServiceRepostsQueueName

The name of the Rabbit queue for the repost service, defaults to reposts

EzConfigServiceConversionsQueueName

The name of the Rabbit queue for the conversion service, defaults to conversions

EzConfigServiceRabbitMQHost

The hostname of the Rabbit server, defaults to localhost

EZGatewayTransformVar

The transform file for EZGateway application install

OctopusMsiTransformCategory

The transform category for all application installs (except Docviewer)

PKGPKTDBAppUsers

This property is the SQL Login Username used by the application to access the database. If running as a Network Service, this will be the machine account for the server hosting Packages and Packets Application and multiple machine accounts can be specified. Syntax for Single Domain/User: -AppUsers "DOMAIN\DGS-CI-SRVC" Syntax for Multiple Machine Accounts (each Machine Account must be separated using the Pipe ( | ) delimiter): -AppUsers "DOMAIN\MACHINENAME1$|DOMAIN\MACHINENAME2$"

PKGPKTDBDrop

Property to indicate whether to drop the database prior to installing the new database. true-will drop the database null/false – (default) will not drop the database

PKGPKTDBName

Property that defines the name of the database. Note: This value needs to also be specified in the Transform file for the application installation.

PKGPKTDBServer

This property is the name of the SQL Server Name that will host the Packages and Packets Database. NOTE: Must include Instance name in the value if applicable.

PKGPKTTransformVar

The transform file for Packages and Packets application install

STS_DB_Mapping_AdminHostname

The hostname of the STSAdmin application

STS_DB_Mapping_AppUsers

The list of users that will be granted access to the STS databases

STS_DB_Mapping_DBServer

The hostname of the database server hosting the STS databases

STS_DB_Mapping_DevSwitch

Keep true if you want all the default certificates installed and some other basic setup done.

STS_DB_Mapping_DGSHostname

The name of the database server hosting the DGS databases

STS_DB_Mapping_DropDatabases

If true, existing databases will be dropped and re-created

STS_DB_Mapping_EDSHostname

The name of the server hosting EDS

STS_DB_Mapping_EZConfigHostname

The hostname of the database server hosting the EZConfig databases

STS_DB_Mapping_GenerateIds

Consider your usage. If false, STSv3 will need to communicate to CoreServices to get IDs for new objects. If you are planning testing migration scenarios, leaving this as false is a good option. This also means you’ll need to modify your CoreServices install

STS_DB_Mapping_HideLegacyProducts

Keep false if you want all legacy apps to appear in STSv3.

STS_DB_Mapping_Hostname

The hostname of the STS application

STS_DB_Mapping_MigrateOspreyAccounts

Setting this to true will migrate accounts, users, roles, etc. from CoreServices to STSv3.

STS_DB_Mapping_MigrateOspreyApp

Setting this to true will migrate the admin1 user from CoreServices to STSv3.

STS_DB_Mapping_STSConfigDB

The name of the STS database. STSConfiguration is the default is this is omitted

STS_DB_Mapping_STSConfigV4DB

The name of the STS database. STSConfigurationV4 is the default is this is omitted

STS_DB_Mapping_STSAuthDB

The name of the STS database. STSAuth is the default is this is omitted

STS_DB_Mapping_WebHelpHostName

STS_DB_UseMappings

Required to set. If this is not set to true, the custom CI install will not happen and you will get a whole bunch of default values everywhere

STSHost

The HTTPS URL to STS application https://hostname

STSv3TransformVar

The transform file for STS application install

UsingBlobStorage

A boolean indicator; a "true" value indicates that BLOB storage is used for PDF and transaction data. By default, this value is set to "false".

BlobStorageAccountName

Part of the connection string; configured as part of storage account creation.

BlobStorageAccountKey

Part of the connection string; configured as part of storage account creation.

BlobStorageEndpointSuffix

Part of the connection string; configured as part of storage account creation.

BlobStorageContainerName

Part of the connection string; configured as part of storage account creation.

BlobStorageRetryCount

Sets the number of transaction retries that can occur to BLOB storage before a transaction fails. The default setting is "5".

BlobStorageRetryDelayMs

Sets the interval (in milliseconds) between transaction retries that can occur to BLOB storage. The default setting is "1000".