Appendix: Document Generation Services Sample Transforms.xml file

Below is a sample of the Transforms.xml file used in the Document Generation Services installation.

Note: The example below cites specific machine names using the Machine.example.NET nomenclature.
<<Transforms>
	<Transform FileName="Installs\DocGenServicesInstall-64bit.msi" Category="Sample">
		<Property Id="SECURITYTOKENCACHEDB" Value="Server=LABW6408HVM998.WKMNLAB.NET;database=AppSecurityTokenCache;Integrated Security=True;"/>
		<Property Id="SHORTTERMSQLSERVERHOSTNAME" Value="Data Source=LABW6408HVM998.WKMNLAB.NET;Initial Catalog=DocGen;Integrated Security=true;"/>
		<Property Id="STSHOSTNAME" Value="LABW6412HVM993.WKMNLAB.NET"/>
		
		<Property Id="CONTENTREPOSITORY" Value="\\LABW6412HVM991.WKMNLAB.NET\ExpereRepository\DeployedContent"/>
		<Property Id="BUILDREPOSITORYPATH" Value="\\LABW6412HVM991.WKMNLAB.NET\ExpereRepository\BuildContent"/>
		<Property Id="ERLCONTENTREPOSITORY" Value="\\LABW6412HVM991.WKMNLAB.NET\ExpereRepository\DeployedERLContent"/>
		<Property Id="LIBRARYZIP" Value="\\LABW6412HVM991.WKMNLAB.NET\ExpereRepository\Uploads"/>
		<Property Id="LIBRARYTODEPLOY" Value="\\LABW6412HVM991.WKMNLAB.NET\ExpereRepository\temp"/>
		
		<Property Id="APPLICATIONURL" Value="LABW6408HVM989.WKMNLAB.NET"/>
		<Property Id="RabbitMQNetworkName" Value="WKFS_DocGenServices"/>
		
		<Property Id="RUNASSERVICEACCT" Value="0"/>
<!-- uncomment and updated accordingly if RUNASSERVICEACCT is 1 
		<Property Id="ACCOUNTDOMAIN" Value="NA"/>
		<Property Id="DOMAINACCOUNT" Value="DGS-CI-SRVC"/>
		<Property Id="DOMAINACCOUNTPASSWORD" Value="Welcome@586!"/>
-->		
		<Property Id="DOCVIEWERURL" Value="https://LABW6412HVM992.WKMNLAB.NET/DocViewerInterfaceHtml/SessionSvc.svc"/>
		
		<Property Id="ENABLENEWRELIC" Value="false"/>
		<Property Id="NEWRELICAPPNAME" Value="DGS_CI"/>
		<Property Id="SetDocGenSvcHostConcurrentConsumerLimit" Value="4"/>

		<!-- leave GENERATESCHEMA as false, we do not want DGS to analyze the schema as part of processing each transaction.  
		We run DocGenServices.DBInstall.exe to update the DocGen database -->
		<Property Id="GENERATESCHEMA" Value="false"/>

		<!-- Expere variables -->
		<Property Id="USE_EXPERE_NET" Value="false"/>
		<Property Id="EXPERE_ENDPOINT_ADDRESS" Value="http://localhost:8080/Common/WSEndpoint"/>

		<!-- Use the thumbprint from the "STS OIDC Signing Cert" ; the STS and DGS values should be the same.-->
		<Property Id="STSv3SigningCertThumbprint" Value="2779B33709C859B45EEDDB3342DD30B9F40E82FE" />
		<Property Id="DGS.STSv3SigningCertThumbprint" Value="2779B33709C859B45EEDDB3342DD30B9F40E82FE" />
		
		<!-- the default is true, we are setting this false since we are using a Load Balancer -->
		<Property Id="ENABLE_ORGANIZATION_CACHE" Value="false"/>
		
		<Property Id="OPPSAHOSTNAME" Value="LABW6412HVM992.WKMNLAB.NET"/>
		
		<!-- This is used by the ToolSuite to present a checkbox for the PNP functionality.  Change this to false to disable the checkbox -->
		<Property Id="ShowPackagesAndPackets" Value="true" />

		<!-- The username/password is used by DGS when processing a package request, to lookup information using a PNP API 
			Note: Admin1 is a service account and the password does not expire.  If you use a different account for this setting, be sure the account is a service account whose password does not expire

             <!-- Settings for EZConfig Integration -->
             <Property Id="EZClientId" Value="6.EZConfigDefaultData.12345678.CustomClient.1"/>
		<Property Id="EZClientCertificate" Value="<insert certificate value here>="/>
		<Property Id="EZScope" Value="wk-ezcfg-def-data-su wk-ezcfg-pkg-pkt-su"/>
		<Property Id="EZMainUrl" Value="https://magnum-pi.wkmnlab.net/"/>  
             <Property Id="ShowEzConfig" Value="true"/>

             <Property Id="ExpereHealthCheckLib" Value="ChangeME"/>
             <Property Id="TODPODCredentialsVisible" Value="true"/>
	      <Property Id="RabbitMqURL" Value="rabbitmq://localhost">
	      <Property Id="CleanAfterBuild" Value="True">
	      <Property Id="DeployLibraryRetryCount" Value="3"/>
             <Property Id="DeployLibraryRetryIntervalMilliseconds" Value ="60000"/>
	      <Property Id="EZTransformInstalled" Value="true" />		
	</Transform>
</Transforms>

Additional considerations

Consider additional guidelines when using the following properties:

  • RUNASSERVICEACCT – Set this value to "0" to install the services as NETWORK SERVICE. Set this value to "1" to use the account information in the properties below;
  • ACCOUNTDOMAIN – The domain of the service account the services should be running as;
  • DOMAINACCOUNT – The username name of the service account;
  • DOMAINACCOUNTPASSWORD – The password of the service account;
  • EXPERE_ENDPOINT_ADDRESS – This is the full URL for Expere’s web service, they will need to change the hostname to the name of the server that they have Expere installed on and the port if they changed that from the default when they installed it.
  • SetDocGenSvcHostConcurrentConsumerLimit – Defines how many concurrent transactions the Expere engine can process. This value defaults to "4," but can be tuned to match the number of CPU cores on the server. If the server has 8 CPU cores, then you can update this value to "8"
  • GENERATESCHEMA - Set this value to "false" to ensure DGS does not analyze the schema as part of processing each transaction. We run DocGenServices.DBInstall.exe to update the DocGen database.
  • OPPSAHOSTNAME – Needs to be set to the fully qualified hostname for the server that OPPSA is installed on. This property is used by DGS’ Tool Suite to retrieve any data set up in OPPSA that should be applied when the documents are generated (Org, policy, product data, etc).
  • ENABLE_ORGANIZATION_CACHE - By default, this property is set to "true," which caches the OPPSA organization database. When Document Generation Services is installed with Expere, set this value to "false."
  • SHOWPACKAGESANDPACKETS: Used by the Tool Suite to present a checkbox for PNP functionality; change the value to "false" to disable this checkbox.
  • EZClientId: the client ID used to access EZ Config, and the client ID from STS created for the separate "integrator" account.
  • EZClientCertificate: the client certificate used to access EZ Config, and the certificate from STS created for the separate "integrator" account. Note that it must be converted to base64 format similar to the other certificates created in STS for packages and packets or default data API authorization.
  • EZScope: Do not change this value.
  • EZMainUrl: the main URL used to access EZ Config.
  • ShowEzConfig: the configuration setting to turn our EZ Config check on/off. When set to "true," EZ Config is called when completing Update Group of Aliases, or Redirect Single Alias in the Management Tool; conversely when set to "false," EZ Config is not called when completing Update Group of Aliases, or Redirect Single Alias in the Management Tool.
    Note: By default, this value is set to "false."
  • ExpereHealthCheckLib: the name of the HealthCheck library that is used to check if Expere is running. The default value is "1.ExpereHealthCheck.1.ORG.WoltersKluwerFinancialServices.Root"
  • TODPODCredentialsVisible: consider the following:
    • When determining which environment to use, you will need to pass in the following:
      • If the TODPODCredentialsVisible flag in the DGS transforms.xml file is set to true and the value of /Txn/EOriginalPreviewOnDemandEnvironmentInd is equal to '1' (Preview On Demand) then DGS passes the Environment Property with a value of 1
      • If the TODPODCredentialsVisible flag in the DGS transforms.xml file is set to true and the value of /Txn/EOriginalPreviewOnDemandEnvironmentInd is equal to '0' OR is Blank (Test On Demand) then DGS passes the Environment Param with a value of 0
      • If the TODPODCredentialsVisible flag in the DGS transforms.xml file is set to false DGS passes either '0', '1' or '2' based on the existing code and the single set of credentials that are stored when the flag is set to false
    • When set to "true," the DGS Setup page will display a section to enter credentials for TestOnDemand and PreviewOnDemand sections in the CT environment.
    Note: This property is only applicable to those users who are integrating with eOriginal. By default, a "false" value will appear, and as a result users are not required to enter a value.
  • DeployLibraryRetryCount and DeployLibraryRetryIntervalMilliseconds are internal settings used with a data migration process.
  • EZTRANSFORMINSTALLED: Used to enable or disable the Expere EZ Transform service in the DGS Tool Suite; change the value to "false" to disable this service.
Note: The DOMAINACCOUNT and DOMAINACCOUNTPASSWORD values identified in the example above should be replaced with your unique values.