Generate Excel

This handler (com.rierino.handler.ExcelExportEventHandler) provides ability to produce well formatted Excel files using templates and input payload.

Handler Parameters

Parameter	Definition	Example	Default
template.state	Name of the state manager with template definitions	template_xlsx	handler_excel
output.system	Alias of the system to store Excel file produced on	s3_default	-

This handler requires the following dependency added to deployment contents:

implementation (group:'com.rierino.custom', name: 'excel', version:"${rierinoVersion}")

Actions

ExportXLSX

Produces Excel file from given input data and template id. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Input Element	Json path for the input in request event payload	customer	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Template	Id of the template to use from code.state	landing_page	-
Input Pattern	JMESPath pattern to apply on input element	{sheets: list}	-
Sheets Path	Json path in payload including data for sheets (in {[sheet_name]: [ {[field]: [value]} ]} format)	list	sheets
Output Path	Json path in payload defining the output file path on target file system	file_path	path

JSON Schema

Content Format

Templates used by this handler have the following data format:

{
    "name": "NAME",
    "header": {},
    "columns":[
        {"title": "TITLE", "field": "FIELD", "titleStyle": {}, "rowStyle": {}}
    ],
    "footer": {}
}

titleStyle and rowStyle are provided using Apache POI cell style keys.