Modify Transforms.xml File

The necessary installation files are located in the EZGateway\InstallTransformKit folder found on the release media provided. Copy this folder and all contents to the server where the EZ Gateway 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 EZ Gateway application will be installed.

Contents of the “EZGateway\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.EZGateway.Installer.msi and Transforms.xml to create the EZ Gateway installer packager (.msi).
  • WoltersKluwerFS.EZGateway.Installer.msi – this is an installer package with default configuration values used as a template by the MsiTransform.exe program to generate the final EZ Gateway 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.

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.
Table 1. EZ Gateway Transform Properties
Transform Property Description
EZGateway.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”).
EZGateway.AppPoolName Property to define Application Pool Name for IIS.
EZGateway.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.
EZGateway.HostName Fully qualified server name for the EZ Gateway application including protocol. If configuring a load balanced environment, specify the load balanced server name.
EZGateway.Expere.Url This property is the URL to connect to Expere.
EZGateway.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’.
EZGateway.HealthCheck.Offset

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

Health Check Page URL: https://example.domain.net/EZConfig/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).
EZGateway.HealthCheck.StsStatusJson

Optional. This property is only needed if using the Expere EZ Gateway 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"/>
EZGateway.DefaultData.HostUrl Optional. This property is only needed if using Expere EZ Config Default Data for logo definition to be applied to documents during Expere Document Generation.
EZGateway.PackagesAndPackets.HostUrl This property is the host name of the Expere EZ Config Packages and Packets application.
EZGateway.DefaultData.ServiceEnabled This property is used to determine if the Default Data application is installed on the environment with EZ Gateway.

This property and the EZGateway.PackagesAndPackets.ServiceEnabled property are used to connect EZ Gateway to the Packages and Packets and Default Data programs. At least one of these properties must be set to true, or the APIs will return the following error message:

EZ Gateway connection error. Please review configuration between EZ Gateway and the EZ Config components.
EZGateway.PackagesAndPackets.ServiceEnabled This property is used to determine if the Packages and Packets application is installed on the environment with EZ Gateway.

This property and the EZGateway.DefaultData.ServiceEnabled property are used to connect EZ Gateway to the Packages and Packets and Default Data programs. At least one of these properties must be set to true, or the APIs will return the following error message:

EZ Gateway connection error. Please review configuration between EZ Gateway and the EZ Config components.
EZGateway.UseAppPoolUser Optional. This property is used to set the identity of the AppPool user to something other than Network User.
EZGateway.AppPoolUserName Optional. If UseAppPoolUser is set to true, use this property to specify username.
EZGateway.AppPoolUserDomain Optional. If UseAppPoolUser is set to true, use this property to specify user domain.
EZGateway.AppPoolUserPassword Optional. If UseAppPoolUser is set to true, use this property to specify user password.