Close
Alfresco Document Transformation Engine

Installation

The standalone Alfresco Document Transformation Engine is installed by using an .msi file where you can either:

  • Select to install a T-Engine wrapper from the .msi.
  • Install a hybrid version by using a Docker Compose file to install the T-Engine.

In previous versions the installation files were contained within a .zip file. This file also contained .amp files that enabled you to install the Document Transformation client into Alfresco Content Services. In the current version this is not possible.

Install with MSI

Note: When upgrading the Document Transformation Engine, the previous installation must be uninstalled first.

  • If your old version is earlier than 1.3.1, use the Control Panel Uninstall a program option to remove the old version, and then manually remove the Document Transformation Engine directory. By default, the Document Transformation Engine directory is C:\Program Files (x86)\Transformation Engine\.
  • If your old version is 1.3.1 or later, the new Document Transformation Engine MSI prompts you to uninstall the previous version. When the uninstall is complete, you can run the MSI package again to install the new version. There is no need to manually remove anything.
  1. Download alfresco-document-transformation-engine-server-2.3.0.msi from the Alfresco Support Portal.

  2. Log into the Microsoft Windows Server as an administrator.

  3. Double click the .msi installer package, and then click Next.

  4. Review the supported software requirements, and then click Next.

  5. (Optional) Select DTE T-Engine.

    Important: If you do not intend to use the DTE T-Engine Docker image, you must select this option for DTE to work correctly.

  6. Click Next and the license information screen displays.

  7. Click Next and select an installation folder or accept the default folder, and then click Next.

  8. Click Next to start the installation.

    You will see a progress bar and a command line window during the installation. The installer will show a confirmation when the installation is finished.

  9. Click Close to finish the installation.

  10. Verify that the installation has completed successfully.

    1. Check the Windows Services in the management console.

    2. Locate the new service called Document Transformation Engine, and check that it is Started.

Note: Each time a file is transformed in Alfresco Content Services, the .NET program starts and Microsoft Office tries to check for a Certificate Revocation List (CRL). Depending on the access that the Document Transformation Engine has to the Internet when transforming a file, this check can delay the operation for up to two minutes, and will therefore, delay transformation of the file. To prevent this, use the Windows server firewall to block internet access for all office binaries.

Install T-Engine using Docker Compose

To deploy the Document Transformation Engine T-Engine with the Transform Service, you’ll need to update your Docker Compose file to include the Document Transformation Engine T-Engine.

Important: You still need to install the Document Transformation Engine using the .msi.

Note: While Docker Compose is often used for production deployments, the Docker Compose file provided is recommended for development and test environments only. Customers are expected to adapt this file to their own requirements, if they intend to use Docker Compose to deploy a production environment.

  1. Add the Document Transformation Engine T-Engine container to your docker-compose.yaml file:

     transform-dte-engine:
         image: quay.io/alfresco/transform-dte-engine:1.0.0
         mem_limit: 2g
         environment:
             JAVA_OPTS: " -Xms256m -Xmx512m -DdteServerUrl=http://<dte hostname>:8080/transformation-server"
             ACTIVEMQ_URL: "nio://activemq:61616"
             ACTIVEMQ_USER: "admin"
             ACTIVEMQ_PASSWORD: "admin"
             FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
         ports:
             - 8091:8090
         links:
             - activemq
    
  2. Add the following JAVA_OPTS property to the alfresco container:

     -DlocalTransform.transform-dte.url=http://transform-dte-engine:8090/
    

See the Content Services documentation - T-Engine configuration for more details. For further development, see Content Transformers and Renditions Extension Points.

Edit this page

Suggest an edit on GitHub
This website uses cookies in order to offer you the most relevant information. Please accept cookies for optimal performance. This documentation is subject to the Alfresco documentation terms.