saveDataLocally

Saves data as a local file.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"data" (required)	String	The encoded data.	null
"dataEncoding" (required)	String	The encoding of the data.	null
"fileName" (required)	String	The name of the file to save the data at.	null
"onError"	String	Event that will be fired if the saving was successfull.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess"	String	Event that will be fired if the saving was successfull.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Saves a base 64 encoded PDF

Show ExampleHide Example

Goal: The PDF can be used in a pdf layer.

Saves the data, which is encoded in the given encoding, as a local file.

{
  "type": "saveDataLocally",
  "params": {
    "data": "{{pdfData}}",
    "dataEncoding": "base64",
    "fileName": "voucher.pdf"
  }
}