From cf2c356f2aac24be19377ba788e1b5192c612cde Mon Sep 17 00:00:00 2001 From: Adelaide Nxumalo <27953420+anxumalo@users.noreply.github.com> Date: Thu, 10 Aug 2023 14:01:17 +0100 Subject: [PATCH] [DOCS-7307] Update install, config, and support sections of DTE 2.4 docs (#1096) * [DOCS-7307] Update versions and fix localTransform.transform-dte.url * [DOCS-7307] Remove commented-out AMP install steps * [DOCS-7307][DOCS-7308] Update supported stack for DTE 2.4 * [DOCS-7307] Move stack versions to SP page and minor fixes * [DOCS-7307] Clarify support status for DTE 2.4 * [DOCS-7307] Remove commented-out section in DTE 2.3 msi.md This section is no longer needed so removing it. --- transformation-engine/2.3/config/index.md | 4 +- transformation-engine/2.3/install/msi.md | 35 +---------------- transformation-engine/latest/config/index.md | 4 +- transformation-engine/latest/install/index.md | 8 ++-- transformation-engine/latest/install/msi.md | 39 ++----------------- transformation-engine/latest/install/sdk.md | 6 +-- transformation-engine/latest/support/index.md | 13 +++++-- 7 files changed, 25 insertions(+), 84 deletions(-) diff --git a/transformation-engine/2.3/config/index.md b/transformation-engine/2.3/config/index.md index d67f08bf06..5feb5e4d58 100644 --- a/transformation-engine/2.3/config/index.md +++ b/transformation-engine/2.3/config/index.md @@ -127,8 +127,8 @@ Below is a very basic example of how to configure Secure Sockets Layer (SSL) for 3. Edit `alfresco-global.properties`: - Change `localTransform.transform-dte.url=http::8080/transform-dte` + Change `localTransform.transform-dte.url=http://:8080/transform-dte` - to `localTransform.transform-dte.url=http::8443/transform-dte` + to `localTransform.transform-dte.url=http://:8443/transform-dte` For more information on configuring SSL on Tomcat, see the Tomcat documentation [SSL/TLS Configuration How-To](https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html){:target="_blank"}. diff --git a/transformation-engine/2.3/install/msi.md b/transformation-engine/2.3/install/msi.md index 829830e5d8..b08f123ede 100644 --- a/transformation-engine/2.3/install/msi.md +++ b/transformation-engine/2.3/install/msi.md @@ -57,42 +57,9 @@ In previous versions the installation files were contained within a `.zip` file. 11. Add the following property to `alfresco-global.properties`: ```bash - localTransform.transform-dte.url=http::8080/transform-dte + localTransform.transform-dte.url=http://:8080/transform-dte ``` - - ## 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. diff --git a/transformation-engine/latest/config/index.md b/transformation-engine/latest/config/index.md index d67f08bf06..5feb5e4d58 100644 --- a/transformation-engine/latest/config/index.md +++ b/transformation-engine/latest/config/index.md @@ -127,8 +127,8 @@ Below is a very basic example of how to configure Secure Sockets Layer (SSL) for 3. Edit `alfresco-global.properties`: - Change `localTransform.transform-dte.url=http::8080/transform-dte` + Change `localTransform.transform-dte.url=http://:8080/transform-dte` - to `localTransform.transform-dte.url=http::8443/transform-dte` + to `localTransform.transform-dte.url=http://:8443/transform-dte` For more information on configuring SSL on Tomcat, see the Tomcat documentation [SSL/TLS Configuration How-To](https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html){:target="_blank"}. diff --git a/transformation-engine/latest/install/index.md b/transformation-engine/latest/install/index.md index bda76e8592..374d244cf7 100644 --- a/transformation-engine/latest/install/index.md +++ b/transformation-engine/latest/install/index.md @@ -6,17 +6,17 @@ The standalone Document Transformation Engine runs on Microsoft Windows and prov ## Prerequisites -There are a number of important notes to consider when installing the Document Transformation Engine in addition to the [supported platforms]({% link transformation-engine/latest/support/index.md %}). +There are a number of important notes to consider when installing the Document Transformation Engine in addition to the [Supported platforms]({% link transformation-engine/latest/support/index.md %}). * The Document Transformation Engine requires an installation of [Alfresco Transform Service]({% link transform-service/latest/install/index.md %}). * The standalone Document Transformation Engine requires the software components to be installed and available on the same machine. -* Only install the English versions of Microsoft Windows Server 2012, Microsoft Windows Server 2016 or Microsoft Windows Server 2019, and Microsoft Office because other languages cause encoding issues resulting in unpredictable behavior. +* Only install the English versions of Microsoft Windows Server, and Microsoft Office because other languages cause encoding issues resulting in unpredictable behavior. > **Note:** Although the engine must be configured in English, this has no impact on the transformation language used for documents. -* Microsoft Office 2016 or 2019 32-bit & 64-bit. +* Microsoft Office (32-bit and 64-bit). * To enable the Document Transformation Engine to work with non-English documents you must install the desired Microsoft Office language pack of the language you want to work with. @@ -24,6 +24,8 @@ There are a number of important notes to consider when installing the Document T * Make sure that the Windows print spooler service is running. +See [Supported platforms]({% link transformation-engine/latest/support/index.md %}) for more information. + ### Sizing There are a number of recommendations for calculating sizing. You will need: diff --git a/transformation-engine/latest/install/msi.md b/transformation-engine/latest/install/msi.md index 829830e5d8..b0cf857c25 100644 --- a/transformation-engine/latest/install/msi.md +++ b/transformation-engine/latest/install/msi.md @@ -19,7 +19,7 @@ In previous versions the installation files were contained within a `.zip` file. > * 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.1.msi` from [Hyland Community](https://community.hyland.com/){:target="_blank"}. +1. Download `alfresco-document-transformation-engine-server-2.4.x.msi` from [Hyland Community](https://community.hyland.com/){:target="_blank"}. 2. Log into the Microsoft Windows Server as an administrator. @@ -33,7 +33,7 @@ In previous versions the installation files were contained within a `.zip` file. > **Note:** > - >* For Alfresco Content Services 7.x, you can only use the T-Engine approach for now. Installing the Alfresco Module Packages (AMP) files is not possible. + >* For Alfresco Content Services 7.x, you can only use the T-Engine approach. Installing the Alfresco Module Packages (AMP) files is no longer supported. >* You can use Content Services 6.x with the T-Engine approach and with the old approach (i.e. installing the AMP files in Content Services). 6. Click **Next** and the license information screen displays. @@ -57,42 +57,9 @@ In previous versions the installation files were contained within a `.zip` file. 11. Add the following property to `alfresco-global.properties`: ```bash - localTransform.transform-dte.url=http::8080/transform-dte + localTransform.transform-dte.url=http://:8080/transform-dte ``` - - ## 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. diff --git a/transformation-engine/latest/install/sdk.md b/transformation-engine/latest/install/sdk.md index 5029cca3ee..f707afee3c 100644 --- a/transformation-engine/latest/install/sdk.md +++ b/transformation-engine/latest/install/sdk.md @@ -4,12 +4,12 @@ title: Install the SDK Use this information to install the Document Transformation Engine SDK. -Download the Document Transformation Engine SDK from [Hyland Community](https://community.hyland.com/){:target="_blank"}.This is an executable jar file with all dependencies that works as a command line client. The executable class is `com.westernacher.transformationserver.demo.DemoClient`. +Download the Document Transformation Engine SDK from [Hyland Community](https://community.hyland.com/){:target="_blank"}. This is an executable JAR file with all dependencies that works as a command line client. The executable class is `com.westernacher.transformationserver.demo.DemoClient`. -To invoke the Document Transformation Engine SDK jar file, use the following syntax: +To invoke the Document Transformation Engine SDK JAR file, use the following syntax: ```java -java -jar alfresco-document-transformation-engine-sdk-2.3.0-plain.jar -in input.doc -out output.pdf -url http://trafo-url:8080/transformation-server +java -jar alfresco-document-transformation-engine-sdk-2.4.x-plain.jar -in input.doc -out output.pdf -url http://trafo-url:8080/transformation-server ``` An API usage example is available at `com.westernacher.transformationserver.demo.ApiUsageExample`. You can copy, modify, and use this code in your own product. diff --git a/transformation-engine/latest/support/index.md b/transformation-engine/latest/support/index.md index 367c53e384..5c9ab954a7 100644 --- a/transformation-engine/latest/support/index.md +++ b/transformation-engine/latest/support/index.md @@ -2,21 +2,26 @@ title: Supported platforms --- -The following are the supported platforms for Document Transformation Engine 2.3.1: +The following are the supported platforms for Document Transformation Engine 2.4: | Version | Notes | | ------- | ----- | -| Content Services 7.1.x | *Optional.* Use with DTE T-Engine v1.2.0 | -| Content Services 7.0.x | *Optional.* Use with DTE T-Engine v1.2.0 | +| Content Services 7.4.x | *Required.* Use with DTE T-Engine v1.2.0 | +| Content Services 7.3.x | *Required.* Use with DTE T-Engine v1.2.0 | +| Content Services 7.2.x | *Required.* Use with DTE T-Engine v1.2.0 | +| Content Services 7.1.x | *Required.* Use with DTE T-Engine v1.2.0 | +| Content Services 7.0.x | *Required.* Use with DTE T-Engine v1.2.0 | | | | | **Java** | | | Oracle JDK 11 | | | | | -| **Microsoft Windows Server** | | +| **Microsoft Windows Server** | | +| Microsoft Windows Server 2021 | | | Microsoft Windows Server 2019 | | | Microsoft Windows Server 2016 | | | Microsoft Windows Server 2012 | | | | | | **Microsoft Office** | | +| Microsoft Office 2021 32/64 bit | | | Microsoft Office 2019 32/64 bit | | | Microsoft Office 2016 32/64 bit | |