Modify Transforms.xml File

The necessary installation files are located in the PackagesAndPackets\InstallTransformKit folder found on the release media provided. Copy this folder and all contents to the server where the Packages and Packets application will be installed.

Note: The folder and contents could be copied to any server for modification and preparation of the final windows installer package (.msi). The final install package (.msi) created from the steps outlined below needs to be copied and executed from the server where the Packages and Packets application will be installed.

Contents of the “PackagesAndPackets\InstallTransformKit” folder:

  • Run.bat – this batch file that calls the MsiTransform.exe with appropriate parameters to produce an .msi executable.
  • Transforms.xml – The Transforms.xml file contains the properties and values used to create configuration settings for the installer package (.msi).
  • MsiTransform.exe – this executable uses the WoltersKLuwerFS.PKGPKT.Installer.msi and Transforms.xml to create the Packages and Packets installer packager (.msi).
  • WoltersKLuwerFS.PKGPKT.Installer.msi – this is an installer package with default configuration values used as a template by the MsiTransform.exe program to generate the final Packages and Packets installer packager (.msi).

Locate the Transforms.xml file. Add and modify the transform property values based on your environment configuration. The Transforms.xml properties are used to create a windows installer package (.msi). See Appendix A: Sample Transforms.xml File for a sample transform file. The properties are used for web.config settings for communication between the Packages and Packets Application and Database.

Note: Be sure to specify all properties and values in the transforms.xml as the installation logic will assume defaults if the property is not specified and could cause runtime errors.
Transform Property Description
PKGPKT.EnableAntiVirusScan

Set to true to enable anti-virus scanning for all file uploads. Default is false. When enabled, files are scanned before being used by the application.
PKGPKT.CAVA.ApiEndpoint

Specifies the API endpoint for the CAVA anti-virus scanning service. Example: https://cava.example.com/scan
PKGPKT.CAVA.ApiCredentials

Credentials required to authenticate with the CAVA API. Store securely and update as needed.
PKGPKT.Website

Property to define the root website for where application service will be created in Internet Information Services (IIS).

This property defines the default website root folder.

NOTE: If installing under “Default Web Site”, remove this property as the installation defaults to this root folder.

PKGPKT.AppVirtualDirName

Property to define Application Virtual Directory Name for IIS.

Note: It is recommended to leave this value as defined in the sample transform. There are Doc Gen Services transform properties that are needed to configure connectivity to use Packages and Packets application data (transform property=”PnPEndPoint”).
PKGPKT.AppPoolName

Property to define Application Pool Name for IIS.

PKGPKT.STSService.Url URL for STS Application.
PKGPKT.STSAdmin.Url URL for STS Administration Application
PKGPKT.STSService.StsClientId The STS Client ID for the Packages and Packets Application. Set this property value to ‘wk.ez.pkgpkt‘. This property must be set to this value as it is pre-defined.
PKGPKT.IdentityServer.SecretThumbprint Set this property value to the thumbprint for the WKFS.EZ.PackagePackets certificate.
PKGPKT.STSService.STSServiceSigningThumbPrint

This property is the Thumbprint of the certificate your organization has obtained used for signing.

NOTE: This thumbprint should be obtained from the OIDC Signing Certificate that was generated with ‘Generating the STS Certificates’ during the Document Generation Services Installation (WKFS.STSv3.OIDC.SigningCertificate: The certificate that will be used to sign all JWT tokens)
PKGPKT.KeyProtectionCertThumbprint This property is the Thumbprint of the certificate used to encrypt token keys in the database. It is required for Load Balanced environments. This property should always be included in the transform file regardless if the environment is load balance or not. NOTE: This thumbprint should be obtained from the Key Protection Certificate that was generated with ‘Generating the STS Certificates’ during the Document Generation Services Installation (WKFS.STSv3.Key.Protection certificate).

PKGPKT.Expere.URL

 This property is the URL to connect to Expere.
PKGPKT.DocGenServices.Host Fully qualified server where Document Generation Services (DGS) is installed. If configuring a load balanced environment, specify the load balanced server name.
PKGPKT.HostName Fully qualified server name for the Expere® EZ Config Packages and Packets application including protocol. If configuring a load balanced environment, specify the load balanced server name.
PKGPKT.Swagger.Enabled

This property controls enabling use of Swagger, a 3rd party API developer tool by SMARTBEAR that can be used for testing RESTful APIs’.

If the property is not provided, the default value is ‘true’. If not using Swagger, set this to ‘false’.
PKGPKT.HelpLink Property to define the URL for WebHelp. Leave this default value in sample transform file for the Help link in the application to access online help.
PKGPKT.HelpAudience Property to define the audience to display the WebHelp content. Leave the default value (“installed”) as specified in sample transform file to control displaying the appropriate online Help content when accessed from the application.
PKGPKT.SQLHOSTNAME Fully qualified SQL server name, including instance if applicable.
PKGPKT.SQLINITIALCATALOG

Name of the Packages and Packets Database.

Note: This value needs to be the name of DB specified in parameter “–DBName” for the Packages and Packet database scripts.
PKGPKT.SQLINTEGRATEDSECURITY

Property to indicate type of trusted connection to use.

Values: False-SQL Server Authentication, True-Windows Authentication (Integrated Security).

If using Windows Authentication, remove the user and password properties from the transform file:

PKGPKT.SQLUSERNAME, PKGPKT.SQLPASSWORD
PKGPKT.SQLUSERNAME

Property to define the DB connection user that will be used by application to connect to the Packages and Packets DB.

If using Windows Authentication, remove this property.
PKGPKT.SQLPASSWORD

Property to define the DB connection user’s password that will be used by application to connect to the Packages and Packets DB.

If using Windows Authentication, remove this property.
PKGPKT.HealthCheck.Offset

Optional. This property is only needed if using the Expere EZ Config Packages and Packet Health Check Page, which is available for use to check the status of the service/application.

Health Check Page URL: https://example.domain.net/PackagesAndPackets/HealthCheck.aspx (replace “example.domain.net” with fully qualified server name. )

This property sets the cache timeout for Health Check response (specified in seconds). This property is available to set to protect against a distributed denial-of-service (DDOS).
PKGPKT.HealthCheck.StsStatusJson

Optional. This property is only needed if using the Expere EZ Config Packages and Packet Health Check Page, which is available for use to check the status of the service/application.

Fully qualified URL to Security Administration Health Check status API. Example: Value="https://localhost/STSAdministration/HealthCheck/StatusJson"/>
PKGPKT.HealthCheck.EZConfigService Optional. This property is only needed if using the Expere EZ Config Packages and Packets Health Check Page for the EZ Config Service to check the status of the service.

Fully qualified URL to Health Check Page: Value = "http://localhost:30948/HealthCheck"

PKGPKT.LogLevel.Serilog Optional. This property used to set logging detail levels. If the property is not provided, the default value is ‘information.' Set to 'debug' for more thorough Serilog logging details.
PKGPKT.LogLevel.Microsoft Optional. This property used to set logging detail levels. If the property is not provided, the default value is ‘information.' Set to 'debug' for more thorough Mirosoft logging details.
PKGPKT.LogLevel.System Optional. This property used to set logging detail levels. If the property is not provided, the default value is ‘information.' Set to 'debug' for more thorough system logging details.
PKGPKT.ExportImportFileMaxSizeBytes This property is used to set the maximum import and export file size, in bytes. The default value is 6000000.
PKGPKT.UseAppPoolUser Optional. This property is used to set the identity of the AppPool user to something other than Network User.
PKGPKT.AppPoolUserName Optional. If UseAppPoolUser is set to true, use this property to specify username.
PKGPKT.AppPoolUserDomain Optional. If UseAppPoolUser is set to true, use this property to specify user domain.
PKGPKT.AppPoolUserPassword Optional. If UseAppPoolUser is set to true, use this property to specify user password.
PKGPKT.RabbitMQ.AuditsQueueName Use this property to set a message queue name for Audit Reporting purposes.
PKGPKT.SQLTRUSTSERVERCERTIFICATE Use this property to override certificate encryption.
PKGPKT.SQLENABLEENCRYPTION Use this property when the TLS/SSL Encryption is not enabled on the SQL Server and the connection to the database fails when the PKGPKT.SQLTRUSTSERVERCERTIFICATE variable is used to override encryption.
PKGPKT.IdentityServer.IntrospectionClientId Use this property to specify the client used to communicate with applications that use reference tokens.
PKGPKT.IdentityServer.IntrospectionClientSecret Use this property to specify the client secret used to communicate with applications that use reference tokens.
PKGPKT.SQLMULTISUBNETFAILOVER Allows SQL connection strings to use multi-subnet failover for Packages and Packets. This ensures failovers are quick and not dependent on DNS propagation.

Default = true