Enumerations
In this microlearning session, we’ll explore how to work with enumerations in eMagiz. Enumerations refer to a predefined list of acceptable values that a system, whether external or within eMagiz, accepts. We’ll guide you through the process of defining and transforming these values during data transformations. By the end of this session, you’ll be able to confidently manage and map enumerations using the tools available in the Design and Create phases of eMagiz.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
2. Key concepts
This microlearning centers around enumerations.
By enumeration we mean: A defined list of accepted values by a system (i.e. external or eMagiz)
eMagiz natively supports the use of enumerations in transformations with the help of:
- Data models in Design
- Message mapping in Design
- Create message definitions in Create
- Create transformation in Create
3. Enumerations
In this microlearning, we will focus on the use of enumerations when transforming data within eMagiz. With the help of this microlearning, you will know how you can easily define the valid enumeration values and transform them from enumeration to another enumeration with the help of the eMagiz tooling.
eMagiz natively supports the use of enumerations in transformations with the help of:
- Data models in Design
- Message mapping in Design
- Create message definitions in Create
- Create transformation in Create
3.1 Data models in Design
Just as you are used to you simply create the correct system definition in Design as you would. When you create, change, or import an attribute you define the dataType. One of the data types that are supported by eMagiz is an enumeration. By defining this data type for an attribute in Design you say that the attribute in question will only accept certain values. Apart from that, there is nothing else to do in Design.
3.2 Message mapping in Design
The action taken within the message mapping layer in Design does not differ when using enumerations within your transformation.
3.3 Create message definitions in Create
In Create we have to define which values are accepted by the system. To do so you can navigate to the system message or CDM message on flow level (in "Start Editing" mode) and select the attribute in question. If you click on it you will see something appearing on the right. This part that just appeared allows you to define a new enumeration list or pick an existing enumeration. To define a new enumeration list press on the + icon
If you press on the icon a pop-up will be shown that gives you the option to give the list a name and define the accepted values. When you are finished press Save. Subsequently, select the correct enumeration list from the drop-down menu. This should all lead to the following configuration:
Note that when you have imported the message definition in Design eMagiz will automatically have created the enumeration lists and the accepted values for you. If you have done this for both message definitions it is time to move on to the transformation part.
3.4 Create transformation in Create
When you navigate to the transformation you have an option. If the lists between input and output match (i.e. are identical) you don't have to do anything. However, if there is the slightest difference between them you can use the transformation component to execute what we call a value mapping.
With the help of this functionality, you can simply add and/or remove value mappings. A value mapping is nothing more and nothing less than a definition that when you receive value X eMagiz will output value Y (hence the term). After you have mapped all possible combinations you will end up with something as follows:
If you are satisfied you can select the Save button and eMagiz will ensure that the correct values are mapped. Note that you have the option of selected a default output value. This can come in handy if you want to set a default value if there is no input value.
After having done this you have successfully configured the possible enum values and have successfully transformed the values from A to B.
4. Key takeaways
- eMagiz natively supports the use of enumerations in transformations with the help of:
- Data models in Design
- Message mapping in Design
- Create message definitions in Create
- Create transformation in Create
- Think whether you want a default output value