Document Generation Services: configuring Transforms.xml and creating/installing the components

This procedure explains the process for installing Document Generation Services (DGS) and Management Service.

Before installing, verify the following:

  • Verify prerequisites are satisfied. See Prerequisites for more information.
  • Verify you have the certificates imported and access to private keys provided
  • The user should be in administration on the server where DGS components will be installed.
  • User whose DGS account information exists in Transforms.xml would need to be added to Log On as a Service Security Policy.
  • Document Generation Services can run as either the Network Service account on a local machine or under an account on your organization's local network (domain service account). If using Network Service, it must have access to the following items:
    • Right permission to the ExpereRepository share
    • The "docgen" database
    • The AppSecurityTokenStore database

    If using a domain account, To enable the use of the service account, set the RUNASSERVICEACCT to "false" in the Transforms.xml file. Use the following settings:

    Permissions:

    • Correct permission to the ExpereRepository share
    • The "docgen" database
    • The AppSecurityTokenStore database

    Transforms

    • RUNASSERVICEACCT (ex. 1)
    • ACCOUNTDOMAIN (ex. NA)
    • DOMAINACCOUNT (ex. DGS_SERVICE_ACNT)
    • DOMAINACCOUNTPASSWORD (ex. Password123!)

    Security Policy

    • Log On as a Service Security Policy
Note: If performing an upgrade, steps 2 and 3 should have been completed as part of the initital installation; you do not need to repeat these steps.
  1. On one of DGS servers, open Powershell and navigate to ReleaseFiles\DocGenServices\DBInstallerScripts\bin folder. This process populates tables in the DGS database.
  2. From a command line, run the following command: DocGenServices.DBInstall.exe and -server {server} -database DocGen.
    Note: Refer to the Word document for instructions for seeding the database and setting up the client ID.
  3. From ReleaseFiles\DocGenServices\DocGenServices\InstallTransformKit folder, access the Transforms.xml file, change all server names to the desired server name or URL. See Appendix: Sample Transforms.xml file for more information.
    Note: Using "LONGTERMSQLSERVERHOSTNAME," name the archive database the same as the main database but append the word “archive” to the database name.
    Note: You must add the following properties to the Transforms.xml file:
    • EXPERE_ENDPOINT_ADDRESS
    • WAS_HOST_BIND
    • WAS_PORT_BIND
    • OPPSAHOSTNAME
    For more information on these properties, see Appendix: Sample Transforms.xml file.
    Note: If configuring an environment with multiple servers to be load balanced, you must add the following properties to the Transforms.xml file:
    • ENABLE_ORGANIZATION_CACHE (default setting is "true")
  4. Run run.bat to create the Document Generation Services installation file (for example: DocGenServicesInstaller.msi; this name matches the FileName property in the Transforms.xml file) in the Installs folder.
  5. Uninstall the current version of DocGenServices using Control Panel > Add or Remove Programs.
  6. Run the .msi installation file.
  7. Click any of the checkboxes:
    • Doc Gen Services Components
    • Management Service
    Note: Management Service should only be installed on one server
  8. Accept all defaults and click Install.
  9. Check the event logs to troubleshoot any database errors. See Appendix: Using Log Files.
    Note: You may receive a message stating that an issue exists with the Windows Installer package. Click OK and note that your installation was successful.
  10. In an internet browser, enter https://{server}/ToolSuite to access Document Generation Services. Log in with Admin1 credentials changed when creating and installing Security Administration.