loadLocalData

Loads data from a local file. The result is available under 'data'.

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
"dataEncoding" (required)	String	The encoding for the data.	null
"fileName" (required)	String	The name of the file to load the data from.	null
"onError"	String	Event that will be fired if the loading was successfull.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess"	String	Event that will be fired if the loading 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: Loads a PDF as a base 64 string

Show ExampleHide Example

Goal: The base 64 of the PDF is availabe as a parameter.

Loads the given file as an encoded string into the parameters.

{
  "type": "loadLocalData",
  "params": {
    "dataEncoding": "base64",
    "fileName": "voucher.pdf",
    "onSuccess": "pdfData",
    "onSuccessType": "return"
  }
}