Transform Editor

This widget can be used to test a transform action. See Transform section in Actions for more details.


    "type": "transformeditor",
    "actions": {},
    "completeMsgObject": false,
    "dataSource": {},
    "editorOptions": {},
    "input": {},
    "toolbars": {},
    "transform": {
        "type": "transform",
        "aggregateOne": [
Field Description


Optional property, used to implement action pipelines for specific trigger events.


Set this property to true if the entire input message should be available to the transform logic. By default, this is false


Property used to retrieve data from the system


Additional configuration options for the transform editor. The available options can be found here


Defines the input message for the transform editor


Optional property, used to add, customise or hide toolbars.


Defines the transform logic


Refer to the generic widget page for a description of the general principles governing the treatment of data retrieved from a dataSource.

The message returned by the data from a dataSource, defined as an object, is determined by the type field if it matches the widget type. If this is not the case, the input and transform fields are checked in the payload and merged into the model. However, if neither of these fields have been defined, then the payload is assigned to input field.


The transform editor widget supports multiple custom toolbars. For information on configuring custom toolbars, see the toolbars section in the widget documentation.


The following tools have a default implementation on the transform editor widget.

Icon Name Description

Format Btn


This tool can be used to format the text in the editor if required.

Refresh Btn


Refreshes the widget


This tool is used to specify the spacing between tools in the widget toolbar. It can be customised using the style and styleByTheme properties.