> For the complete documentation index, see [llms.txt](https://docs.rierino.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rierino.com/devops/api-event-and-process-flows/configuring-saga-steps/transform-step.md).

# Transform Step

<figure><img src="/files/SYXezJIl4K85CbanUlbF" alt=""><figcaption><p>Transform Definition</p></figcaption></figure>

{% hint style="info" %}
A transform step is always executed locally by the saga orchestrator runner.
{% endhint %}

Transform steps allow modifying structure of an event payload, which may be required when integrating with 3rd party services or returning data in a format preferred by the front-end applications.

Dragging and dropping a transform step from the icon bar of a saga adds a new transformation, which can be configured by clicking on the edit icon displayed when hovering its node. The following fields are used for overall settings of the transformation:

* **Name:** Descriptive name of the step, which will be displayed on the saga flow.
* **Auto Fail:** Whether failure of this step should automatically fail the whole saga flow. If not set to true (or the saga itself has auto fail setting), error status should be handled separately.
* **Description:** Verbal description of the step, for reference and documentation.
* **Stroke:** Color to use for drawing borders of the step, for visual purposes.
* **Fill:** Color to use for filling the step node, for visual purposes.

The actual functionality of a transform step is defined using settings listed on the parameters tab:

* **Transform Class:** Type of the transform handler to use (such as JMESPath Transformation, Add Value to Payload).
* **Transform Parameters:** Transform class specific list of parameters to use.&#x20;

## Transform Step Data Schema

```json
	{
		"transformClass": {
			"type": "string",
			"description": "The Java class for transformation (e.g., `com.rierino.handler.transform.JMESPayloadTransform`)"
		},
		"transformParameters": {
			"type": "object",
			"description": "Key-value pair parameters used by the specific transform class (such as pattern for JMESPath transform class)"
		}
	}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rierino.com/devops/api-event-and-process-flows/configuring-saga-steps/transform-step.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.