Removing headers from your message

Last modified by Erik Bakker on 2024/09/09 12:47

Within eMagiz, you can place headers on your message, and you can subsequently also remove these headers again. For example, when some form of authentication is placed in headers, you do not want to send this information to an external party connecting to another system. Removing headers has been a tedious process, but with some new functionality, it is easier and more evident to remove them.

Should you have any questions, please get in touch with academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

  • There is a specific component called "Header filter" that will remove the headers for you
  • In this component, you can define all headers you want to filter out of your message

3. Removing headers from your message

Within eMagiz, you can place headers on your message, and you can subsequently also remove these headers again. For example, when some form of authentication is placed in headers, you do not want to send this information to an external party connecting to another system. Removing headers has been a tedious process, but with some new functionality, it is easier and more evident to remove them.

3.1 Legacy approach

In the old situation, you need to add a standard header enricher to your flow and set the header to null via a SPeL expression.

migration-path-removing-headers-from-your-message--old-solution-basic.png

migration-path-removing-headers-from-your-message--old-solution-advanced.png

3.2 New approach

In the new situation, you can more intuitively set up the removal of these headers. This can be done by using a unique and specific component that has the sole purpose of removing headers from your message. The part is called the header filter, and in it, you can define the names of all headers you want to remove. For example, a wildcard search using an asterisk (\*) is also possible. This way, you remove all custom set headers from your message. See below for an illustration.

migration-path-removing-headers-from-your-message--old-solution-configuration.png

3.3 How to get to the new approach

Migrating from the old way of removing headers from messages to the new way of eliminating them takes several steps to make it work correctly. Below you will find all these steps. Follow them carefully to achieve the desired result.

  1. Identify a flow where you remove a header in the old way or don't remove the header at all where it would be wise to do so (in case of authentication, for example, or privacy-sensitive information)
    2. Add the header filter component to the flow
    3. Add the correct header names (or a wildcard) to the header names field
    4. Press Save
    5. Remove the old functionality where you set the value to null for a specific header.

Congratulations, you have successfully migrated to an excellent and easy way to remove headers from your message.

4. Key takeaways

  • There is a specific component called "Header filter" that will remove the headers for you
  • In this component, you can define all headers you want to filter out of your message

5. Suggested Additional Readings