Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:11
From version 10.1
edited by Erik Bakker
on 2022/06/10 12:35
Change comment: There is no comment for this version
To version 9.2
edited by Erik Bakker
on 2022/06/10 12:29
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Cleanup a captured integration
1 +novice-lifecycle-management-cleanup-a-captured-integration
Content
... ... @@ -1,78 +1,73 @@
1 1  {{container}}
2 2  {{container layoutStyle="columns"}}
3 3  (((
4 -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)
4 +In this microlearning, we will learn how you can import store items from the eMagiz store in Design after finding the one for you. This microlearning aims to get you acquainted with the various options of importing a store item in the Design phase of eMagiz.
5 5  
6 6  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 -* Last update: May 14th, 2021
8 +* Last update: April 5th, 2021
9 9  * Required reading time: 5 minutes
10 10  
11 11  == 1. Prerequisites ==
12 12  
13 13  * Basic knowledge of the eMagiz platform
14 -* Basic knowledge of the build number component within the eMagiz Platform
15 15  
16 16  == 2. Key concepts ==
17 17  
18 -This microlearning is about cleaning up a captured integration.
17 +This microlearning centers around importing store items in the Design Phase. With eMagiz Store, we mean A content library available to the community to select re-usable solutions within the eMagiz platform.
19 19  
20 -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)
19 +* To import a store item in Design, you need to follow the import wizard
20 +* When importing in Design, you can import the system message and accompanying flow fragments
21 21  
22 -There are four essential considerations before cleaning up a captured integration:
22 +== 3. Importing Store Items - Design Phase ==
23 23  
24 -* Is the integration/flow not mentioned anymore in any alerting in Manage?
25 -* Is the integration removed from all releases?
26 -* Is the integration removed from Create?
27 -* Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned?
24 +In contrast with the Create phase store items (which provide you a set of components to achieve a particular objective), the Design Phase store items give you the additional functionality to import the system message(s). For example, to import a system message from the Store in Design, you must navigate to the system message via the context menu. When doing so for the first time, eMagiz will show you the following options after entering the "Start Editing" mode.
28 28  
29 -== 3. Cleanup a captured integration ==
26 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items-design--import-options-system-message.png]]
30 30  
31 -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)
28 +When you select the option Store, eMagiz will show you all alternatives within the eMagiz store to which a Message Definition is linked. Note that you can search by Name and by Brand in this overview.
32 32  
33 -There are four essential considerations before cleaning up a captured integration:
30 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items-design--store-overview-design.png]]
34 34  
35 -* Is the integration/flow not mentioned anymore in any alerting in Manage?
36 -* Is the integration removed from all releases?
37 -* Is the integration removed from Create?
38 -* Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned?
32 +Once you have found the item of your liking, you can select it by clicking on it. This action will lead you to the details page associated with the store item. Here you will find the relevant information related to this store item. On top of that, we provide you with a Versions & Variants tab that shows you all existing versions you could import.
39 39  
40 -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.
34 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items-design--information-store-item-after-selection.png]]
41 41  
42 -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:
36 +In cases where you want the latest version use the button titled "Use latest version" on the Information tab. Once you have selected a version, eMagiz will show the following step of the process. Here you can choose whether you want to import the message definition(s), and it will ask you whether you wish to select accompanying flow fragments which are of use later on in Create. Since it is a GET operation, we only have a response definition to import. On top of that, we have two flow fragments. One that handles the authentication and one that holds the logic of the store item.
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--not-able-to-remove.png]]
38 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items-design--making-choices-on-the-store-item.png]]
45 45  
46 -To remove an integration in Capture, access the context menu (via a right-mouse click) and select Delete integration.
40 +It is up to you what you exactly want to import. Maybe only the definition is enough for you, or perhaps you want the whole package. So here you have the choice to do so. Once you are satisfied with your selection, press "Use message(s)." This will start the import process. As a result, eMagiz will import the model on the canvas and define the system message(s) in the right panel.
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-integration.png]]
42 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items-design--import-result-in-design.png]]
49 49  
50 -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.
44 +Now you should create the mapping from your data model to the system message(s) yourself, and when you are finished, you can transfer the solution to Create just as you are used to doing.
51 51  
52 -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.
46 +=== 3.1 Importing Design Store Item - Effect in Create ===
53 53  
54 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-system.png]]
48 +Once you have transferred the solution to the Create phase and open the relevant flow for which you have imported the store item, you will see a "Pending configuration" button on the bottom of your canvas.
55 55  
56 -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.
50 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items--pending-configuration.png]]
57 57  
58 -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.WebHome||target="blank"]]. Make note that is an advanced action that only a bus 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.
52 +After pressing this button, you will see a pop-up showing all flow fragments to import. You can select each flow fragment separately by pressing the Setup button. Note that if you want to configure this at a later moment, you can choose the option "Do this later" and come back later to finish the job. On top of that, you can press Cancel if you change your mind and don't want to import the flow fragments.
59 59  
60 -Armed with this knowledge, you can make the correct decision in cases where you consider cleaning up the captured integration.
54 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items--importing-flow-fragments.png]]
61 61  
56 +When pressing this, eMagiz will show you the import wizard. This configuration wizard finishes the import process.
57 +
58 +[[image:Main.Images.Microlearning.WebHome@novice-emagiz-store-importing-store-items--configuration-wizard.png]]
59 +
60 +For all the details on this wizard, please check out the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Novice Level.eMagiz Store.novice-emagiz-store-configuring-store-items.WebHome||target="blank"]].
61 +
62 62  == 4. Assignment ==
63 63  
64 -Determine whether you can clean up a captured integration within your project. If so, execute the cleanup.
65 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
64 +Import a Store item in Design to import the system message(s) and subsequently transfer it to Create to see how to import the pending configurations. This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
66 66  
67 67  == 5. Key takeaways ==
68 68  
69 -* There are four essential considerations before cleaning up a captured integration:
70 - * Is the integration/flow not mentioned anymore in any alerting in Manage?
71 - * Is the integration removed from all releases?
72 - * Is the integration removed from Create?
73 - * Is the eMagiz data model (i.e., CDM, API Gateway Data model) cleaned?
74 -* Before deletion, eMagiz will ask for confirmation
75 -* Deletion means that you cannot get it back anymore
68 +* To import a store item in Design, you need to follow the import wizard
69 +* When importing in Design, you can import the system message and accompanying flow fragments
70 +* After importing the system message in Design, you can configure the flow fragments in Create with the help of the button called "Pending configurations."
76 76  
77 77  == 6. Suggested Additional Readings ==
78 78  
... ... @@ -80,9 +80,7 @@
80 80  
81 81  == 7. Silent demonstration video ==
82 82  
83 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned
78 +{{video attachment="novice-emagiz-store-importing-store-items-design.mp4" reference="Main.Videos.Microlearning.WebHome"/}})))
84 84  
85 -{{video attachment="novice-lifecycle-management-cleanup-a-captured-integration.mp4" reference="Main.Videos.Microlearning.WebHome"/}})))
86 -
87 87  ((({{toc/}}))){{/container}}
88 88  {{/container}}