Wiki source code of Cleanup a captured integration
Last modified by Erik Bakker on 2024/08/26 12:11
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{container}} |
| 2 | {{container layoutStyle="columns"}} | ||
| 3 | ((( | ||
| |
19.1 | 4 | In this microlearning, we’ll cover the final step of cleaning up a captured integration. A captured integration refers to the detailed setup of data traffic between a system and eMagiz. We'll walk you through the crucial considerations to ensure a thorough cleanup, including checking its status across various phases and verifying that all related data models are up to date. By following these steps, you can ensure that the integration is fully and effectively removed from your eMagiz environment. |
| |
1.1 | 5 | |
| 6 | Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 7 | |||
| 8 | == 1. Prerequisites == | ||
| 9 | |||
| 10 | * Basic knowledge of the eMagiz platform | ||
| |
10.1 | 11 | * Basic knowledge of the build number component within the eMagiz Platform |
| |
1.1 | 12 | |
| 13 | == 2. Key concepts == | ||
| 14 | |||
| |
10.1 | 15 | This microlearning is about cleaning up a captured integration. |
| |
1.1 | 16 | |
| |
10.1 | 17 | By captured integration, we mean: A line that symbolizes data traffic between a system and eMagiz for which the specific information is filled in (i.e., captured) |
| |
1.1 | 18 | |
| |
10.1 | 19 | There are four essential considerations before cleaning up a captured integration: |
| |
1.1 | 20 | |
| |
10.1 | 21 | * Is the integration/flow not mentioned anymore in any alerting in Manage? |
| 22 | * Is the integration removed from all releases? | ||
| 23 | * Is the integration removed from Create? | ||
| 24 | * Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned? | ||
| |
1.1 | 25 | |
| |
10.1 | 26 | == 3. Cleanup a captured integration == |
| |
1.1 | 27 | |
| |
10.1 | 28 | In this microlearning, we will focus on the 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 last step of the process is to remove the integration from Capture (and potentially the system) |
| |
1.1 | 29 | |
| |
10.1 | 30 | There are four essential considerations before cleaning up a captured integration: |
| |
1.1 | 31 | |
| |
10.1 | 32 | * Is the integration/flow not mentioned anymore in any alerting in Manage? |
| 33 | * Is the integration removed from all releases? | ||
| 34 | * Is the integration removed from Create? | ||
| 35 | * Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned? | ||
| |
1.1 | 36 | |
| |
10.1 | 37 | As you can see, a theme starts to develop itself. Each of the considerations focuses on a particular phase within eMagiz. We begin at Manage, move to Deploy, Create and Design before we end up in Capture. Removing integrations in the advised way will ensure that the deletion of the integration and everything that accompanies it will be successful. |
| |
1.1 | 38 | |
| |
10.1 | 39 | However, there is no check done on all these aspects when you want to delete the integration. Therefore it is up to you to uphold the quality. There is one exception to this: the integration needs to be removed from Create before you can clean it up (i.e., delete) in Capture. If the integration is not yet removed from Create, you will see the following pop-up: |
| |
1.1 | 40 | |
| |
10.1 | 41 | [[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--not-able-to-remove.png]] |
| |
1.1 | 42 | |
| |
10.1 | 43 | To remove an integration in Capture, access the context menu (via a right-mouse click) and select Delete integration. |
| |
1.1 | 44 | |
| |
10.1 | 45 | [[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-integration.png]] |
| |
1.1 | 46 | |
| |
10.1 | 47 | When selecting this option, eMagiz will ask for confirmation to make sure that you know what you are doing. Confirming that you want to delete the integration means throwing away all captured information, including attached documents. Furthermore, it means that all message mappings, system messages, and design configurations are also gone, except for entities and attributes on the eMagiz data model (CDM, API GW, EVS) level as they are shared. |
| |
1.1 | 48 | |
| |
10.1 | 49 | In cases where the integration you have just cleaned up is the last integration tying a system to eMagiz, you should also delete the system itself. To do so, access the context menu on the system level and select the option Delete system. |
| |
1.1 | 50 | |
| |
10.1 | 51 | [[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-system.png]] |
| |
1.1 | 52 | |
| |
10.1 | 53 | Once again, you will receive a confirmation pop-up. Confirming, in this case, means deleting all captured information on the system level and removing all designed information on the system level. |
| |
4.1 | 54 | |
| |
13.1 | 55 | One last consideration to consider when removing the system is to determine whether your captured system was already part of the Create and Deploy phase of eMagiz. If that was the case, additional measures are needed to properly clean up the system and all related information in the Deploy phase of eMagiz. In that case, you need to Delete your runtime in Deploy on all three environments. More on how to do so can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-cleanup-a-deployed-runtime||target="blank"]]. Make note that is an advanced action that only a model owner can perform within your project. If you did not yet transfer the integration and the system to the Create phase, this action is unnecessary as the runtime does not exist in the Deploy phase. |
| |
4.1 | 56 | |
| |
10.1 | 57 | Armed with this knowledge, you can make the correct decision in cases where you consider cleaning up the captured integration. |
| |
4.1 | 58 | |
| |
14.1 | 59 | == 4. Key takeaways == |
| |
1.1 | 60 | |
| |
10.1 | 61 | * There are four essential considerations before cleaning up a captured integration: |
| 62 | * Is the integration/flow not mentioned anymore in any alerting in Manage? | ||
| 63 | * Is the integration removed from all releases? | ||
| 64 | * Is the integration removed from Create? | ||
| 65 | * Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned? | ||
| 66 | * Before deletion, eMagiz will ask for confirmation | ||
| 67 | * Deletion means that you cannot get it back anymore | ||
| |
1.1 | 68 | |
| |
14.1 | 69 | == 5. Suggested Additional Readings == |
| |
1.1 | 70 | |
| |
16.1 | 71 | * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] |
| 72 | ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]] | ||
| 73 | *** [[Configure an integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-integration||target="blank"]] | ||
| |
17.1 | 74 | * [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] |
| 75 | ** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome||target="blank"]] | ||
| |
18.1 | 76 | *** [[Cleanup a designed integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.novice-lifecycle-management-cleanup-a-designed-integration||target="blank"]] |
| |
17.1 | 77 | * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] |
| 78 | ** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Lifecycle Management.WebHome||target="blank"]] | ||
| 79 | *** [[Cleanup a created integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Lifecycle Management.intermediate-lifecycle-management-cleanup-a-created-integration||target="blank"]] | ||
| 80 | ** [[Defining message structures (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.WebHome||target="blank"]] | ||
| 81 | *** [[Cleaning up the CDM>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Defining message structures.intermediate-defining-your-message-structures-cleaning-up-the-cdm||target="blank"]] | ||
| 82 | * [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] | ||
| 83 | ** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]] | ||
| 84 | *** [[Cleanup a deployed runtime (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-cleanup-a-deployed-runtime||target="blank"]] | ||
| |
20.1 | 85 | * [[Lifecycle Management (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22lifecycle+management%22||target="blank"]] |
| |
1.1 | 86 | |
| |
16.1 | 87 | |
| |
15.1 | 88 | )))((({{toc/}}))){{/container}}{{/container}} |