mirror of
https://github.com/Alfresco/alfresco-transform-core.git
synced 2025-08-14 17:58:27 +00:00
7ca8a483ad
Adding extra error messages to the t-config checking, for the case where a pipeline specifies source and target mimetypes that cannot be provided by the step transformers, so that it will be clearer that the pipeline t-config is wrong. In the case of the AI rendition tests the AI-transform t-config has a pipeline that uses libreoffice as a step transformer, to transform some source to text/plain before asking AWS_AI to process it into the final mimetype. However libreoffice does not convert to text/plain. What is happening is that the request was still being sent to the all-in-one t-engine that contains libreoffice, and it workout that it should be using the tika transformer. As a result the pipeline works by accident. The size check that was commented out (uncommented now) was just finding out that libreoffice was unable to do the transform and was reporting it. officeToComprehendPiiEntityTypesViaText is the pipeline with the error.
Alfresco Transform Core
Contains the common transformer (T-Engine) code, plus a few implementations.
Sub-projects
model- library packaged as a jar file which contains the data model of json configuration files and messages sent between clients, T-Engines and T-Router. Also contains code to to combine and then work out which transform to use for a combination of source and target mimetypes and transform options.engines/base- contains code common to t-engines, packaged as a jar. READMEengines/<name>- multiple T-Engines, which extend theengines/base; each one builds a SpringBoot jar and a Docker imagedeprecated/alfresco-base-t-engine- The original t-engine base, which may still be used, but has been replaced by the simplerengines/baseREADME
Documentation
docs- provides additional documentation.- ACS Packaging docs folder
- If you're interested in the Alfresco Transform Service (ATS) see https://docs.alfresco.com/transform/concepts/transformservice-overview.html
Building and testing
The project can be built by running the Maven command:
mvn clean install -Plocal,docker-it-setup
The
localMaven profile builds local Docker images for each T-Engine.
Artifacts
Maven
The artifacts can be obtained by:
- downloading from Alfresco repository
- getting as Maven dependency by adding the dependency to your pom file:
<dependency>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-model</artifactId>
<version>version</version>
</dependency>
<dependency>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-base-t-engine</artifactId>
<version>version</version>
</dependency>
and Alfresco Maven repository:
<repository>
<id>alfresco-maven-repo</id>
<url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
</repository>
Docker
The core T-Engine images are available on Docker Hub.
Either as a single Core AIO (All-In-One) T-Engine:
Or as a set of individual T-Engines:
- alfresco/alfresco-imagemagick
- alfresco/alfresco-pdf-renderer
- alfresco/alfresco-libreoffice
- alfresco/alfresco-tika
- alfresco/alfresco-transform-misc
You can find examples of using Core AIO in the reference ACS Deployment for Docker Compose:
You can find examples of using the individual T-Engines in the reference ACS Deployment for Helm / Kubernetes:
Release Process
For a complete walk-through check out the
build-and-release.MD
under the docs folder.
Contributing guide
Please use this guide to make a contribution to the project.