Table Of Contents
- Introduction
- Creating and maintaining entity transformers
- Managing entity transformers in other configurations
Introduction
Entity transformers are used to perform actions related to the data within your integrations. Examples of such actions are transforming it to the desired format, creating caching layers to optimize your integrations, or enriching your data object by doing additional API calls.
Entity transformers can be created and maintained by navigating to Connections → Entity transformers.
Creating and maintaining entity transformers
Possible configuration fields:
- Name - A name describing the transformation this configuration performs, i.e. Move customer_id to customer_number field
- Identifier - A unique identifier for this entity transformer (this field is automatically generated based on the name).
- Description - Detailed description for the entity transformer.
- Disabled - A flag that indicates whether the entity transformer configuration is disabled. Disabled entity transformer configurations do not process data.
- Settings - The type of entity transformer to be used for this configuration.
In addition to the fields above, the entity transformer page also presents two JSON fields on the right side of the screen. The upper field takes the input data, the data before the entity transformer is executed, and the lower field displays the result of the entity transformer.
Managing entity transformers in other configurations
For Routes, Incoming and Outgoing configurations it’s essential to know that entity transformers are managed in a separate popup to keep a consistency of usage and split the huge amounts of information placed through the entire page like in the old layout.
Nevertheless, you can, as usually, select a proper configuration and test it in the transformer tester placed in the popup with the main settings. Let’s have a deeper look.
- To manage entity transformers, click on the appropriate button - it’s called the same “Manage entity transformers” at the bottom of all entity transformers settings and then the popup expands to you.
- If you have added any entity transformer to your configuration recently, it should appear in the popup. You can always change it to another configuration as well.
- If you want to create a new entity transformer, there is no need to go to the Entity transformers option and create a new one. It’s possible to create a new transformer from this popup - just click on the “+” button and a new tab expands with the ability to input all settings. Once you click on the “Save&Close” button at the right bottom of the popup, you’ll return to the main popup window and see the new configuration has been added to the field by default.
- Also you can add a new entity transformer by clicking on the “Add entity transformer” button. Then an empty field appears to let you add a proper transformer in it.
- Besides, as everywhere in Alumio, you are able to view selected configurations. For this, just click on the “View configuration” option below the input field and it’ll appear in the next tab of this popup.
- To test your configurations, use the Transformer tester and see the results with the logs as you normally did on the page while setting up some entity transformers.
- Once all changes are applied, click on the “Save&Close” button to collapse the popup.
- As a result, you’ll see that as more transformers you have added via the popup, the more records appear on the page in the non-editable view. To edit records, use the same flow as p.1.