Modify Transforms.xml File
The necessary installation files are located in the
DefaultData\InstallTransformKit folder found on the release media
provided. Copy this folder and all contents to the server where the Default Data
application will be installed.
Contents of the “DefaultData\InstallTransformKit” folder:
Run.bat– this batch file that calls theMsiTransform.exewith appropriate parameters to produce an .msi executable.Transforms.xml– TheTransforms.xmlfile contains the properties and values used to create configuration settings for the installer package (.msi).MsiTransform.exe– this executable uses theWoltersKluwerFS.DefaultData.Installer.msiandTransforms.xmlto create the Default Data installer packager (.msi).WoltersKluwerFS.DefaultData.Installer.msi– this is an installer package with default configuration values used as a template by theMsiTransform.exeprogram to generate the final Default Data 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 Default Data
Application and Database.
| Transform Property | Description |
|---|---|
| CAVA.ApiEndpoint |
Specifies the API endpoint for the CAVA anti-virus scanning service. Example: https://cava.example.com/scan |
| CAVA.ApiCredentials |
Credentials required to authenticate with the CAVA API. Store securely and update as needed. |
| DefaultData.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. |
|
DefaultData.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 Default Data application data (transform property=”PnPEndPoint”). |
| DefaultData.AppPoolName |
Property to define Application Pool Name for IIS. |
| DefaultData.STSService.Url | URL for STS Application. |
| DefaultData.STSAdmin.Url | URL for STS Administration Application |
| DefaultData.STSService.StsClientId | The STS Client ID for the Default Data Application. Set this property value to 'wk.ez.default.data'. This property must be set to this value as it is pre-defined. |
| DefaultData.IdentityServer.SecretThumbprint | Set this property value to the thumbprint for the WKFS.EZ.DefaultData certificate. |
| DefaultData.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) |
| DefaultData.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). |
| DefaultData.Expere.URL | This property is the URL to connect to Expere. |
| DefaultData.DocGenServices.Host | Fully qualified server where Document Generation Services (DGS) is installed. If configuring a load balanced environment, specify the load balanced server name. |
| DefaultData.HostName | Fully qualified server name for the Expere® EZ Config Default Data application including protocol. If configuring a load balanced environment, specify the load balanced server name. |
| DefaultData.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’. |
| DefaultData.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. |
| DefaultData.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. |
| DefaultData.SQLHOSTNAME | Fully qualified SQL server name, including instance if applicable. |
| DefaultData.SQLINITIALCATALOG | Name of the Default Data Database. Note: This value needs to be the name of DB specified in parameter “–DBName” for the Default Data database scripts. |
| DefaultData.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: DefaultData.SQLUSERNAME, DefaultData.SQLPASSWORD |
| DefaultData.SQLUSERNAME | Property to define the DB connection user that will be used by application to connect to the Default Data DB. If using Windows Authentication, remove this property. |
| DefaultData.SQLPASSWORD | Property to define the DB connection user’s password that will be used by application to connect to the Default Data DB. If using Windows Authentication, remove this property. |
| DefaultData.HealthCheck.Offset | Optional. This property is only needed if using the Expere EZ Config Default Data Health Check Page, which is available for use to check the status of the service/application. Health Check Page URL: https://example.domain.net/DefaultData/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). |
| DefaultData.HealthCheck.StsStatusJson | Optional. This property is only needed if using the Expere EZ Config Default Data 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"/> |
| DefaultData.HealthCheck.EZConfigService | Optional. This property is only needed if using the Expere EZ Config
Default Data 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" |
| DefaultData.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. |
| DefaultData.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 Microsoft logging details. |
| DefaultData.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. |
| DefaultData.LogoFileBase64MaxSizeBytes | This property is used to set the maximum logo file size, in bytes. This file size of the encrypted file in Base64 format. (Note that .png and .jpg files are approximately 25% smaller, so a 600 kb file limit is approximately 420kb .jpg or .png.) |
| DefaultData.ExportImportFileMaxSizeBytes | This property is used to set the maximum import file size, in bytes. The default value is 6000000. |
| DefaultData.MassTransitSettings.Host | This value is used to specify a host value for RabbitMQ. The default is 'localhost'. |
| DefaultData.MassTransitSettings.AccountsQueueName | Optional. This property is used to set up a queue for account messages. The default value is set to 'accounts'. |
| DefaultData.MassTransitSettings.RepostsQueueName | Optional. This property is used to set up a queue for repost messages. The default value is set to 'reposts'. |
| DefaultData.MassTransitSettings.ConversionsQueueName | Optional. This property is used to set up a queue for conversion messages. The default value is set to 'conversions'. |
| DefaultData.RabbitMQSettings.CopiesQueueName | Optional. This property is used to set up a queue for copy messages. The default value is set to 'copies'. |
| EzConfigServiceCopiesQueueName | Optional. This property is used to specify which RabbitMQ queue to
use between Default Data and EZ Config Service when users are creating
copies. By default this message is set to Copies. This
setting should be identical between Default Data and EZ Config
Service. |
| DefaultData.UseAppPoolUser | Optional. This property is used to set the identity of the AppPool user to something other than Network User. |
| DefaultData.AppPoolUserName | Optional. If UseAppPoolUser is set to true, use this
property to specify username. |
| DefaultData.AppPoolUserDomain | Optional. If UseAppPoolUser is set to true, use this
property to specify user domain. |
| DefaultData.AppPoolUserPassword | Optional. If UseAppPoolUser is set to true, use this
property to specify user password. |
| DefaultData.MassTransitSettings.AuditsQueueName | Use this property to set a message queue name for Audit Reporting purposes. |
| DefaultData.SQLTrustServerCertificate | Use this property to override certificate encryption. |
| DefaultData.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
DefaultData.SQLTrustServerCertificate variable is
used to override encryption. |
| DefaultData.IdentityServer.IntrospectionClientId | Use this property to specify the client used to communicate with applications that use reference tokens. |
| DefaultData.IdentityServer.IntrospectionClientSecret | Use this property to specify the client secret used to communicate with applications that use reference tokens. |
| DefaultData.SQLMULTISUBNETFAILOVER | Allows SQL connection strings to use multi-subnet failover for
Default Data. This ensures failovers are quick and not dependent on DNS
propagation. Default = true |