Cleanup a designed integration
In this microlearning, we'll cover the essential steps for cleaning up a designed integration. A designed integration involves the detailed setup for data traffic between a system and eMagiz, including message definitions and design settings. We’ll guide you through the key considerations you need to address before proceeding with the cleanup, ensuring that all relevant phases in eMagiz are properly managed. By following these steps, you'll ensure a thorough and effective cleanup process.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
- Basic knowledge of the build number component within the eMagiz Platform
2. Key concepts
This microlearning centers around cleaning up a designed integration.
By designed integration we mean: A line that symbolizes data traffic between a system and eMagiz for which the solution is designed (i.e. message definition, message mapping, design settings)
There are four key considerations before cleaning up a designed integration:
- Is the integration/flow not mentioned anymore in any alerting in Manage?
- Is the integration removed from all releases?
- Is the integration removed from Create?
- What should I clean up in Design that is not automatically done when I cleanup Capture?
3. Cleanup a designed integration
In this microlearning, we will focus on the second to last step of cleaning up your integration. As we learned in previous microlearnings the lifecycle management process starts in Manage and ends in Capture. Following that logic, the second to last step of the process is to clean up your designed integration.
There are four key considerations before cleaning up a designed integration:
- Is the integration/flow not mentioned anymore in any alerting in Manage?
- Is the integration removed from all releases?
- Is the integration removed from Create?
- What should I clean up in Design that is not automatically done when I cleanup Capture?
As you can see a theme starts to develop itself. Each of the considerations focuses on a particular phase within eMagiz. We start at Manage, move to Deploy, Create and Design before we end up in Capture. Doing this properly will ensure that the deletion of the integration and everything that accompanies it will be successful.
Good to know is that most in Design will automatically be removed when you clean up the captured integration. More on the specifics of that in the next microlearning. For now, it is good to know that the CDM is untouched by that action. That means to ensure a proper cleanup you should verify if certain elements in the CDM are not used anymore and are therefore ready to be cleaned up.
To do so you can search on CDM level for unused parts of the CDM. When you have identified them you can remove them. We will discuss this topic in more detail later on in this microlearning. So before you will do this in a real project take stock of that microlearning.
For this microlearning, it is good to know that apart from the CDM everything in Design will be cleaned up when you clean up the captured integration.
4. Key takeaways
- There are four key considerations before cleaning up a designed integration:
- Is the integration/flow not mentioned anymore in any alerting in Manage?
- Is the integration removed from all releases?
- Is the integration removed from Create?
- What should I clean up in Design that is not automatically done when I cleanup Capture?
- Before deletion eMagiz will ask for confirmation
- Deletion means that you cannot get it back anymore
- The process of removing parts of the CDM will be discussed in more detail later on.