← Back to plugin index

DOCX Save Option
Description
Configuration generating a DOCX file. Saves the document as an Office Open XML WordprocessingML Document (macro-free)
Type name
DocxSaveAction
Class
com.airlock.iam.core.misc.renderer.saveaction.DocxSaveActionConfig
May be used by
Word Template Report Renderer Word Template Password Renderer Word Template Token List Renderer
Properties
File Name Extension (fileNameExtension)
Description
File name extension for the generated DOCX file.
Attributes
String
Optional
Default value
.docx
Fonts Path (fontsPath)
Description

The absolute or relative path containing all TrueType fonts required for the conversion.
This is mandatory on unix-like operating systems and optional on Windows where the installed Windows fonts will always be included automatically.

When loading a document in the DOCX format and saving it back as DOCX, configuring custom fonts might not have a significant impact. The reason is that the DOCX format already embeds the font information within the document itself. This means that the font information is preserved during the save operation, and font substitution might not be necessary. However, there can be scenarios where using this property can still be useful, even when working with DOCX files. For example:

1. Font Substitution: When rendering or converting a document, IAM may encounter fonts that are not available on the system where the operation is being performed. By defining font sources, you provide IAM with a list of locations to search for required fonts. This enables IAM to automatically substitute missing fonts with available alternatives from the defined font sources.

2. Consistent Rendering: Defining font sources allows you to ensure consistent font rendering across different systems. By specifying the exact font sources to be used, you can guarantee that the same fonts will be available and utilized, regardless of the system where the document is processed. This can be crucial for maintaining consistent visual appearance, especially when sharing documents across different environments.

In order to reflect changes from the file system, reactivating the IAM configuration is required.
Attributes
File/Path
Optional
YAML Template (with default values) 

type: DocxSaveAction
id: DocxSaveAction-xxxxxx
displayName: 
comment: 
properties:
  fileNameExtension: .docx
  fontsPath: