Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:11
From version 19.1
edited by Carlijn Kokkeler
on 2024/08/23 14:14
Change comment: There is no comment for this version
To version 3.1
edited by Erik Bakker
on 2022/06/09 10:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Cleanup a captured integration
1 +Importing Store Items - Design Phase
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.eMagiz Store.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.CarlijnKokkeler
1 +XWiki.ebakker
Content
... ... @@ -1,87 +1,69 @@
1 1  {{container}}
2 2  {{container layoutStyle="columns"}}
3 3  (((
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.
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: April 5th, 2021
9 +* Required reading time: 5 minutes
10 +
8 8  == 1. Prerequisites ==
9 9  
10 10  * Basic knowledge of the eMagiz platform
11 -* Basic knowledge of the build number component within the eMagiz Platform
12 12  
13 13  == 2. Key concepts ==
14 14  
15 -This microlearning is about cleaning up a captured integration.
17 +The eMagiz Store is a concept in the eMagiz platform that allows users to import reusable content into a specific ILM phase. The Store has elements for each of the model phases Capture, Design, and Create, and is focused on expediting the delivery of integrations for users.
16 16  
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)
19 +== 3. eMagiz Store - Introduction ==
18 18  
19 -There are four essential considerations before cleaning up a captured integration:
21 +=== 3.1 Store for Create ===
20 20  
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?
23 +The eMagiz store for the Create phase allows users to drag & drop flow fragments into the flow that requires editing. A flow fragment is a combination of 1 or more model components that together can execute a certain piece of work inside that flow. For example, a file pickup that includes an archive option and specific file filters. Or the required components that are needed to send a message to a REST/JSON web service that is secured with OAuth2.0.
25 25  
26 -== 3. Cleanup a captured integration ==
25 +The Store for the Create phase can be found in the left-hand panel of the Flow designer - at the same location as where you select the model components.
27 27  
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)
27 +=== 3.2 Store for Design ===
29 29  
30 -There are four essential considerations before cleaning up a captured integration:
29 +The eMagiz store for the Design phase allows selecting specific operations from available systems such as Exact online, or Salesforce. So these are more datamodel-oriented items and more target/source system oriented. The general idea is that you import store content whilst defining your data model message and System definitions. At that moment, you can select to import one or more message definitions. eMagiz will then guide the user to import the system message definition, as well as to import the mapping between the data model and message definition. A reusable merge definition can be created between the existing data model (CDM, Gateway model, or Event model) and the system definition so that the data model can be updated in a proper way.
31 31  
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?
31 +Please note that when the Store item is selected in this phase, the associated flow fragments for the Create phase are automatically attached to the integration. That means when the integration is transferred to Create these flow fragments will automatically be generated into the appropriate flows. eMagiz considers putting these flow fragments into the right flow depending on the type of flow fragment.
36 36  
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.
33 +* Connectivity flow fragments will be imported in exit gates, entry flow, event processors, and exit flows
34 +* Processing flow fragments will be imported in exit gates, event processors, offramp flows, and onramp flows
35 +* Universal flows can be imported into any flow
38 38  
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:
37 +=== 3.3 Store for Capture ===
40 40  
41 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--not-able-to-remove.png]]
39 +The eMagiz Store will be expanded to the Capture phase in upcoming quarters. The current idea is to allow the selection of systems and integrations on level up so that the work on Design and Create becomes even easier. Once we have made that step, we'll update this section with the right positioning.
42 42  
43 -To remove an integration in Capture, access the context menu (via a right-mouse click) and select Delete integration.
41 +=== 3.4 Content Management for Store items ===
44 44  
45 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-integration.png]]
43 +At this moment, the Store content is provided by the eMagiz team only. The concept of a company or private store is under consideration, and for now, intra-company content can be moderated by the Copy-Paste functionality in the Create phase. Suggestions for new content can be sent to [[productmanagement@emagiz.com>>mailto:productmanagement@emagiz.com]] / questions can be asked via the QA forum which may include feedback on a store item.
46 46  
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.
45 +=== 3.5 Licensing Store ===
48 48  
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.
47 +Store content can be imported by any user except for store items that are licensed. For instance, the Data Sink is a licensed feature, and the Store item for Data Sink can only be imported in case this license is granted in the integration model.
50 50  
51 -[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-cleanup-a-captured-integration--delete-system.png]]
49 +The disclaimer for using Store content can be found here:
52 52  
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.
51 +== 4. Assignment ==
54 54  
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.
53 +There is no assignment for this microlearning. Please refer to the next microlearning in this module so that you can experience it properly.
56 56  
57 -Armed with this knowledge, you can make the correct decision in cases where you consider cleaning up the captured integration.
55 +== 5. Key takeaways ==
58 58  
59 -== 4. Key takeaways ==
57 +* Each phase in eMagiz holds store items that will aid you in building your solution in eMagiz
58 +* eMagiz Store Content will be managed by eMagiz.
60 60  
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
60 +== 6. Suggested Additional Readings ==
68 68  
69 -== 5. Suggested Additional Readings ==
62 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
70 70  
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"]]
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"]]
76 -*** [[Cleanup a designed integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.novice-lifecycle-management-cleanup-a-designed-integration||target="blank"]]
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"]]
64 +== 7. Silent demonstration video ==
85 85  
66 +There is no demonstration video of this functionality.)))
86 86  
87 -)))((({{toc/}}))){{/container}}{{/container}}
68 +((({{toc/}}))){{/container}}
69 +{{/container}}