Generate Excel

These actions provide ability to produce formatted Excel files using templates and input payload.

Generate Excel Actions

ExportXLSX

Produces an 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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Generate Excel ExportXLSX action eventMeta fields",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "inputElement": {
          "type": "string",
          "definition": "Json path for the input in request event payload",
          "example": "customer",
          "default": null
        }
      }
    }
  }
}

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Generate Excel ExportXLSX action eventMeta.parameters",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "templateId": {
              "type": "string",
              "definition": "Id of the template to use from code.state",
              "example": "landing_page",
              "default": null
            },
            "inputPattern": {
              "type": "string",
              "definition": "JMESPath pattern to apply on input element",
              "example": "{sheets: list}",
              "default": null
            },
            "sheetsPath": {
              "type": "string",
              "definition": "Json path in payload including data for sheets (in {[sheet_name]: [ {[field]: [value]} ]} format)",
              "example": "list",
              "default": "sheets"
            },
            "outputPath": {
              "type": "string",
              "definition": "Json path in payload defining the output file path on target file system",
              "example": "file_path",
              "default": "path"
            }
          }
        }
      }
    }
  }
}

Content Format

Templates used by this action have the following data format:

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

titleStyle and rowStyle use Apache POI cell style keys.