If you are a regular user of Alumio, you must know the naming convention that you can use for the integrations including the incoming configuration, the outgoing configuration, the route as well as the entity transformers. Getting the naming conventions right plays a crucial role in any IT system since it makes recognition easy for other people working in the same environment. There won’t be any hassle for them to understand what is going on in a specific system/configuration.

Incoming Configuration 

For incoming configuration, we suggest using the following naming convention for ease of use. 

<platform> get <object> 

You can also put a “-” in between to make the name look compact. However, if you are keeping the naming convention consistent across the whole spectrum, things should work just as fine even without it. 

The Alumio environment can often deal with multiple clients and you can do specific things for each of them. You might even have multiple websites/platforms for a client.

In such a scenario, the best way to name an incoming configuration would be:

<client name> <platform> - get <object> 

For instance, if you are working with Magento and looking to retrieve customer data, the naming can be Magento - get customers following the above convention. 

Click on Save & continue after setting up the configuration and it will be saved.

Outgoing Configuration

For the outgoing configuration, the naming convention remains more or less the same. Here, it can either be a push/create/update/delete. You can also close or open an order.

For instance, the names of the outgoing configurations can look something like this.

SAP - create customers

Magento - delete customers

Click on Save & continue after setting up the configuration and it will be saved.


A route requires an incoming and outgoing configuration to work properly. Any route should adhere to this naming convention for ease of recognition:

<object> from <a> to <b>

If the route is for a specific client, the naming convention can be formatted like this:

<client> <object> from <a> to <b>

So, if you consider the two above-mentioned configurations- Magento - get customers (incoming) and SAP - create customers (outgoing), the route will look something like this:

customers from Magento to SAP 

Click on Save & continue after setting up the route and it will be saved.

Entity Transformer

While naming an entity transformer, the focus should be on making the entities as understandable as possible to the people working in the same environment. 

For instance, if a transformer is being utilized to map data from point A to point B, it would be helpful if the naming configuration looks something like this:

Map <object> from <point A> to <point B>

If you consider the previously mentioned route that channels data from Magento to SAP, the transformer can be named as Map customers from Magento to SAP.

Click on Save & continue after setting up the transformer and it will be saved.

You can easily search for this transformer once it is saved under Entity Transformer from the Route or other segments. It will show up and will be understandable to the relevant users that if it is utilized, it will map the customers from Magento to SAP.

Closing Thoughts

While this article sheds some light on how you should ideally follow the naming conventions, you can always try something different that suits your perspective. The only thing you should ensure if you are using a personalized naming convention is that everyone in your organization working within the Alumio environment must follow the ground rules you set for the personalized naming convention. Stay tuned with us for more informative articles on Alumio!