| Elements configuration reference | ||
|---|---|---|
| Element | Description | Children |
| freemarker-doc-process-config | This is the root element of freemarker-doc-process configuration file | ( docHandlerConfig , docChain ) [1-1] |
| docHandlerConfig | Configuration for DocHandlerFacade containing all needed DocTypeHandlers | ( docHandler ) [1-1] |
| docHandler | Configuration of a specific DocTypeHandler as FactoryType | ( docHandlerCustomConfig ) [1-1] |
| docHandlerCustomConfig | Custom configuration of a doc handler, it can contains unchecked attributes and child elements. | ( ) [1-1] |
| docChain | A document processing chain | ( chainStep ) [1-1] |
| chainStep | A step in a docChain | ( config | function | map ) [1-1] |
| config | Will creates a new free marker configuration | |
| function | The data of a freemarker function to map (the 'name' attributes will be the key, and a new instance of the 'value' attribute as value) | |
| map | An object will be mapped from DocProcessContext to Freemarker Map (the 'name' attributes will be the key, and the 'value' will be used to search in the DocProcessContext attributes) | |
| Element : freemarker-doc-process-config | ||
|---|---|---|
| This is the root element of freemarker-doc-process configuration file | ||
| Attribute | Description | Note |
| validating | If set to 'true' the FreemarkerDocProcessConfig will try to validate the source. (since 8.9.1) NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. | boolean |
| failOnValidate | If set to 'true' the FreemarkerDocProcessConfig will fail in case of validation errors, if 'false' will just print the result as warning. (since 8.9.1) NOTE: 'validating' is set to true, this attribute is ignored. | boolean |
| cleanSource | If set to 'true' the FreemarkerDocProcessConfig will try to clean the source (i.e. DocXmlUtils.cleanXml()). (since 8.9.1) NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. | boolean |
| Element : docHandlerConfig | ||
|---|---|---|
| Configuration for DocHandlerFacade containing all needed DocTypeHandlers | ||
| Attribute | Description | Note |
| registerById | If set to true, the handlers will be registered by id | boolean |
| allowDuplicatedId | If set to true, duplicated id will be allowed (the last one will overwrite the others) | boolean |
| Element : docHandler | ||
|---|---|---|
| Configuration of a specific DocTypeHandler as FactoryType | ||
| Attribute | Description | Note |
| id | Id of the handler | string |
| info | Type of the handler | string |
| type | Type of the handler (fully qualified class name implementing DocTypeHandler) | string |
| unsafe | 'true' is the handler is too be considered unsafe | boolean |
| unsafeMode | Unsafe handling message, ( 'log-message' for simple message or 'log-trace' for full trace) | string |
| Element : docHandlerCustomConfig | ||
|---|---|---|
| Custom configuration of a doc handler, it can contains unchecked attributes and child elements. | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : docChain | ||
|---|---|---|
| A document processing chain | ||
| Attribute | Description | Note |
| id | A chain ID | string |
| parent | A chain parent (will inherits all the chainStep) | string |
| sourceType | The source type : xml (default), json, yaml or kotlin. (since 8.9.6) | sourceType , base : string , enumeration : [ xml , json , yaml , kotlin ] |
| Element : chainStep | ||
|---|---|---|
| A step in a docChain | ||
| Attribute | Description | Note |
| stepType | Can be a java type value implementing DocProcessorBasic or a fixed value for 'config', 'map', 'function', 'complex', 'skipfm' (skip FreeMarkerProcessing, since 8.9.7) 'kotlin' (skip FreeMarkerProcessing, since 8.10.0, use kotlin script, kts-path must be set, dataModel map can still be used and will be bound to the script) | string |
| map-atts | Comma separated list of attributes to map or 'map-all' to map all attributes | string |
| map-all | 'true' if all attributes must be mapped. default 'false'. | boolean |
| template-path | Free marker template path (relative to template base path provided in 'config' step). | string |
| kts-path | Kotlin script (KTS) path in classpath (FreeMarker template base is ignored). (in 'kotlin' step it is possible to use 'template-path' as an alias for this attribute). | string |
| Element : config | ||
|---|---|---|
| Will creates a new free marker configuration | ||
| Attribute | Description | Note |
| id | The new freemarker configuration ID | string |
| path | base freemarker template path | string |
| version | freemarker version to use | string |
| mode | The class loading mode | string |
| class | This class's classloader will be used | string |
| exception-handler | Just a referenced to the relevant freemarker configuration | string |
| log-exception | Just a referenced to the relevant freemarker configuration | boolean |
| wrap-unchecked-exceptions | Just a referenced to the relevant freemarker configuration | boolean |
| fallback-on-null-loop-variable | Just a referenced to the relevant freemarker configuration | boolean |
| load-bundled-functions | It will load all the default funs with the default name | boolean |
| Element : function | ||
|---|---|---|
| The data of a freemarker function to map (the 'name' attributes will be the key, and a new instance of the 'value' attribute as value) | ||
| Attribute | Description | Note |
| name | Name map attribute | string |
| value | Value map attribute | string |
| Element : map | ||
|---|---|---|
| An object will be mapped from DocProcessContext to Freemarker Map (the 'name' attributes will be the key, and the 'value' will be used to search in the DocProcessContext attributes) | ||
| Attribute | Description | Note |
| name | Name map attribute | string |
| value | Value map attribute | string |