Skip to main content

FormatWordDocument

Description

Formats a MS Word docx file

Tags

docx, format, office, word

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Page MarginPage MarginSets the Left/Right Page Margin in twentieths of a point (twips) (1440 twips = one inch). Unset means keep original margin
Input Validation Strategy *Input Validation StrategyDefault
  • Default
  • Advanced
Sets the stategy to use to validate the Word document for zip bombs.
Zip Bomb Ratio Protection Limit *Zip Bomb Ratio Protection Limit0.01Sets the ratio between de- and inflated bytes to detect zipbomb. It defaults to 1% (0.01), i.e. when the compression is better than 1% for any given read package part, the parsing will fail indicating a Zip-Bomb.

This property is only considered if:
  • the property Input Validation Strategy has a value of ADVANCED
Zip Bomb Max File Protection Limit *Zip Bomb Max File Protection Limit10000Sets the maximum file count allowed inside the zip file being read. The default is 1000.

This property is only considered if:
  • the property Input Validation Strategy has a value of ADVANCED

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureIf the Word Document of a FlowFile cannot be formated for any reason, the input FlowFile will be routed to this relationship.
successThe Fomatted Word Document is routed to the success relationship.

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also