Porting custom transforms to the transform service

1. Porting a Custom
Transformer to the New
Transform Service
Alan Davis

2. Learn. Connect. Collaborate.
ACS 6.0 Transformers
ACS repo
Command
Transformer
Transformer
Proxy
Engine
Transformer
Command
101010

3. Learn. Connect. Collaborate.
ACS 6.0 Transformers
ACS repo
Command
Transformer
Transformer
Proxy
Engine
Transformer
Command
101010

4. Learn. Connect. Collaborate.
ACS 6.0 Transformers
ACS repo
Command
Transformer
Transformer
Proxy
Engine
Transformer
Command
101010

5. Learn. Connect. Collaborate.
ACS 6.1 Transformers
ACS repo
Command
Transformer
Transformer
Proxy
Rendition Service 2
(asynchronous)
Engine
Transformer
Command
Transform
Service
Router
101010

6. Learn. Connect. Collaborate.
ACS 6.1 Transformers
ACS repo
Command
Transformer
Transformer
Proxy
Rendition Service 2
(asynchronous)
Engine
Transformer
Command
Transform
Service
Router
101010

7. Learn. Connect. Collaborate.
The Proxy
AbstractContentTransformer2
transformInternal(…)
MyTransformer
transformInternal(…)
AbstractContentTransformer2
transformInternal(…)
MyTransformer
transformLocal(…)
transformRemote(…)
AbstractRemoteContentTransformer
remoteTransformerClient
transformInternal(…)
transformLocal(…)
transformRemote((…)
@Override
protected void transformRemote(
RemoteTransformerClient remoteTransformerClient,
ContentReader reader, ContentWriter writer,
TransformationOptions options,
String sourceMimetype, String targetMimetype,
String sourceExtension, String targetExtension,
String targetEncoding) throws Exception
{
long timeout = options.getTimeoutMs();
String language = getLanguage(options);
String dialect = getDialect(options);
remoteTransformerClient.request(reader, writer,
sourceMimetype, sourceExtension,
targetExtension, timeout, logger,
”language", language,
”dialect", dialect);
}

8. Learn. Connect. Collaborate.
The Proxy
AbstractContentTransformer2
transformInternal(…)
MyTransformer
transformInternal(…)
AbstractContentTransformer2
transformInternal(…)
MyTransformer
transformLocal(…)
transformRemote(…)
AbstractRemoteContentTransformer
remoteTransformerClient
transformInternal(…)
transformLocal(…)
transformRemote((…)
@Override
protected void transformRemote(
RemoteTransformerClient remoteTransformerClient,
ContentReader reader, ContentWriter writer,
TransformationOptions options,
String sourceMimetype, String targetMimetype,
String sourceExtension, String targetExtension,
String targetEncoding) throws Exception
{
long timeout = options.getTimeoutMs();
String language = getLanguage(options);
String dialect = getDialect(options);
remoteTransformerClient.request(reader, writer,
sourceMimetype, sourceExtension,
targetExtension, timeout, logger,
”language", language,
”dialect", dialect);
}

9. Learn. Connect. Collaborate.
Docker Image
The Transform Engine
Spring Boot App
Command
XxxController
transform(…)
processTransform(…)
alfresco-transformer-base
AbstractTransformerController
public void processTransform(
File sourceFile, File targetFile,
Map<String, String> transformOptions,
Long timeout)
{
// Code to build command line options
commandExecutor.run(options, sourceFile,
targetFile, timeout);
}
@PostMapping(value = "/transform", consumes =
MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<Resource> transform(
HttpServletRequest request,
@RequestParam("file")
MultipartFile sourceMultipartFile,
@RequestParam("targetExtension")
String targetExtension,
@RequestParam("language") String language,
@RequestParam("dialect") String dialect,
@RequestParam(value = "timeout",
required = false) Long timeout)
{
// Code to obtain source file
// Code to build command line options
commandExecutor.run(options, sourceFile,
targetFile, timeout);
// Code to return target file as an attachment
}

10. Learn. Connect. Collaborate.
Docker Image
The Transform Engine
Spring Boot App
Command
XxxController
transform(…)
processTransform(…)
alfresco-transformer-base
AbstractTransformerController
public void processTransform(
File sourceFile, File targetFile,
Map<String, String> transformOptions,
Long timeout)
{
// Code to build command line options
commandExecutor.run(options, sourceFile,
targetFile, timeout);
}
@PostMapping(value = "/transform", consumes =
MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<Resource> transform(
HttpServletRequest request,
@RequestParam("file")
MultipartFile sourceMultipartFile,
@RequestParam("targetExtension")
String targetExtension,
@RequestParam("language") String language,
@RequestParam("dialect") String dialect,
@RequestParam(value = "timeout",
required = false) Long timeout)
{
// Code to obtain source file
// Code to build command line options
commandExecutor.run(options, sourceFile,
targetFile, timeout);
// Code to return target file as an attachment
}

11. Learn. Connect. Collaborate.
Configuration
ACS repo
Transform
Service
transform-service-
config.json
Transform Service
Registry
??
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy

12. Learn. Connect. Collaborate.
Configuration
ACS repo
Transform
Service
transform-service-
config.json
Transform Service
Registry
??
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy

13. Learn. Connect. Collaborate.
Configuration
ACS repo
Transform
Service
transform.service.enabled=true
local.transform.service.enabled=true
alfresco-pdf-renderer.url=http://localhost:8090/
img.url=http://localhost:8091/
jodconverter.url=http://localhost:8092/
tika.url=http://localhost:8093/
transform-service-
config.json
alfresco-
global.properties
Transform Service
Registry
??
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy

14. Learn. Connect. Collaborate.
Configuration
ACS repo
Transform
Service
transform.service.enabled=true
local.transform.service.enabled=true
alfresco-pdf-renderer.url=http://localhost:8090/
img.url=http://localhost:8091/
jodconverter.url=http://localhost:8092/
tika.url=http://localhost:8093/
transform-service-
config.json
alfresco-
global.properties
Transform Service
Registry
??
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy

15. Learn. Connect. Collaborate.
When is the Transform Service called?
ACS repo
Transform
ServiceTransform Service
Registry
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy
• Rendition Service 2 has been called:
– V1 REST API
– on content update
– original Rendition Service
• RenditionDefinition2 exist
• Transform Service supports the transform
Transformer

16. Learn. Connect. Collaborate.
When is the Transform Service called?
ACS repo
Transform
ServiceTransform Service
Registry
…
{
"name": "pdfRenderer",
"transformOptions": [
{"value": {"name": "page"}},
{"value": {"name": "width"}},
{"value": {"name": "height"}},
{"value": {"name": "allowPdfEnlargement"}},
{"value": {"name": "maintainPdfAspectRatio"}}
],
"supportedSourceAndTargetList": [
{"sourceExt": "pdf", "targetExt": "png" }
]
},
…
Rendition Service 2
Proxy
• Rendition Service 2 has been called:
– V1 REST API
– on content update
– original Rendition Service
• RenditionDefinition2 exist
• Transform Service supports the transform
Transformer

17. Learn. Connect. Collaborate.
Simplification of Transform Options
Transformation
Options
<bean id="renditionDefinition2DocLib" class="org.alfresco.repo.rendition2.RenditionDefinition2I
<constructor-arg name="renditionName" value="doclib"/>
<constructor-arg name="targetMimetype" value="image/png"/>
<constructor-arg name="transformOptions">
<map>
<entry key="resizeWidth" value="100"/>
<entry key="resizeHeight" value="100"/>
<entry key="allowEnlargement" value="false" />
<entry key="maintainAspectRatio" value="true"/>
<entry key="thumbnail" value="true"/>
<entry key="timeout" value="${system.thumbnail.definition.default.timeoutMs}" />
</map>
</constructor-arg>
<constructor-arg name="registry" ref="renditionDefinitionRegistry2"/>
</bean>
Transform Options
key value
key value
key value

18. Learn. Connect. Collaborate.
Simplification of Transform Options
Transformation
Options
<bean id="renditionDefinition2DocLib" class="org.alfresco.repo.rendition2.RenditionDefinition2I
<constructor-arg name="renditionName" value="doclib"/>
<constructor-arg name="targetMimetype" value="image/png"/>
<constructor-arg name="transformOptions">
<map>
<entry key="resizeWidth" value="100"/>
<entry key="resizeHeight" value="100"/>
<entry key="allowEnlargement" value="false" />
<entry key="maintainAspectRatio" value="true"/>
<entry key="thumbnail" value="true"/>
<entry key="timeout" value="${system.thumbnail.definition.default.timeoutMs}" />
</map>
</constructor-arg>
<constructor-arg name="registry" ref="renditionDefinitionRegistry2"/>
</bean>
Transform Options
key value
key value
key value

19. Learn. Connect. Collaborate.
Future No promises - It might not happen
• Public access to
– alfresco-transformer-base
– sample transformers
• Local Router
– for use by the community
– help develop new Engines
• Remaining transformers
• New transforms metadata extraction
document analysis
AI
translation
image to text
text to voice

20. Learn. Connect. Collaborate.
Future No promises - It might not happen
• Public access to
– alfresco-transformer-base
– sample transformers
• Local Router
– for use by the community
– help develop new Engines
• Remaining transformers
• New transforms metadata extraction
document analysis
AI
translation
image to text
text to voice

21. Learn. Connect. Collaborate.
Future No promises - It might not happen
• Public access to
– alfresco-transformer-base
– sample transformers
• Local Router
– for use by the community
– help develop new Engines
• Remaining transformers
• New transforms metadata extraction
document analysis
AI
translation
image to text
text to voice

22. Porting a Custom
Transformer to the New
Transform Service
Thank you!