Base64 encoding
Most of the time, you can use the standard tooling of eMagiz to manipulate the data so that it makes sense for the (external) party that receives the data. However, sometimes there are cases in which you need a little bit of extra complexity. This microlearning will explain one of those more complex scenarios. In this microlearning, we will learn how to use base64 encoding on your (input) message. This functionality is beneficial when the message is not encoded, but you need to send the data encoded to the external party.
Should you have any questions, please get in touch with academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
2. Key concepts
This microlearning centers around base64 encoding.
We mean turning the string into an encoded string that the external party can handle.
Essential characteristics of this functionality are:
- Encoding (and decoding) of base64 strings take up additional memory (up to 33%)
- Separate integration for the base64 strings apart from metadata is advisable
- The component in eMagiz needs a base64 encoded string as input
- Multiple times encoding and decoding in the same integration is not advisable
3. Base64 encoding
Most of the time, you can use the standard tooling of eMagiz to manipulate the data so that it makes sense for the (external) party that receives the data. However, sometimes there are cases in which you need a little bit of extra complexity. This microlearning will explain one of those more complex scenarios. In this microlearning, we will learn how to use base64 encoding on your (input) message. This functionality is beneficial when the message is not encoded, but you need to send the data encoded to the external party.
Essential characteristics of this functionality are:
- Encoding (and decoding) of base64 strings take up additional memory (up to 33%)
- Separate integration for the base64 strings apart from metadata is advisable
- The component in eMagiz needs a base64 encoded string as input
- Multiple times encoding and decoding in the same integration is not advisable
The Base64 encode algorithm converts the original string into a base64 encoded string. Technically, it can be said that it converts eight-bit bytes into six-bit bytes. So when you have a string of ABC, you could manually convert this to an encoded format. You can find an excellent explanation of how it works here. Luckily for us, eMagiz will do all the heavy lifting, and we do not have to take out pen and paper.
In the remainder of this microlearning, we will look at how you could implement this logic within the eMagiz tooling.
3.1 Implementation
To implement this logic, we need to add a separate component to our flow at the point where we want to encode the base64 string. This is generally part of your processing. The most logical place would be a flow associated with processing (i.e., offramp, exit gate, event processor).
First, we need to navigate to the Create phase of eMagiz and open the flow in which we want to add this logic. Once you have opened your flow, you need to enter "Start editing" mode. This mode allows you to change the flow in question and add the logic to the transformation within the flow. When you have done so, it becomes time to add the base64 encode component to the flow.
At the component level, you need to define the input and output channel. Note that when the charset of the input message deviates from the UTF-8 default, you should specify the charset on the Advanced tab.
3.2 Use cases
Now that we know how to implement it, we can quickly look at possible use cases for this logic. We see this logic popping up mainly when dealing with attachments/files (i.e., pictures, pdf) within XML messages.
4. Key takeaways
Essential characteristics of this functionality are:
- Encoding (and decoding) of base64 strings take up additional memory (up to 33%)
- Separate integration for the base64 strings apart from metadata is advisable
- The component in eMagiz needs a base64 encoded string as input
- Multiple times encoding and decoding in the same integration is not advisable
5. Suggested Additional Readings
If you are interested in this topic and want more information, please read the help text provided by eMagiz and the following links: