Changes for page Upgrading Build Numbers

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Importing Store Items - Design Phase
	1	+Upgrading Build Numbers

Parent

...	...	@@ -1,1 +1,1 @@
1		-Main.eMagiz Academy.Microlearnings.Novice.eMagiz Store.WebHome
	1	+Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome

Content

...	...	@@ -1,61 +1,102 @@
1	1	{{container}}
2	2	{{container layoutStyle="columns"}}
3	3	(((
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.
	4	+{{error}}
	5	+Note that the functionality mentioned in this microlearning will become obsolete when migrating to the 3rd generation runtime.
	6	+{{/error}}
	7	+In this microlearning, we will focus on how you can upgrade your build numbers within eMagiz consistently and easily. Knowing how to upgrade your build numbers will ensure that you will keep your eMagiz solution as up to date as possible and therefore also as stable and secure as possible.
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		-
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
14	14
15	15	== 2. Key concepts ==
16	16
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.
	18	+This microlearning centers around upgrading your build numbers.
18	18
19		-== 3. eMagiz Store - Introduction ==
	20	+By upgrading we mean: Ensuring that your eMagiz solution is running on the latest open source and eMagiz software as is possible within the confinements of the customer context
	21	+By build number we mean: An identification that the dependency to other pieces of the solution has changed. Each build number has a unique set of dependencies
20	20
21		-=== 3.1 Store for Create ===
	23	+There are three key considerations when updating build numbers:
22	22
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	+* Why should I upgrade my build numbers?
	26	+* How do I determine which of my flows can be updated with ease?
	27	+* How should I handle the build number upgrade?
24	24
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.
	29	+== 3. Upgrading Build Numbers ==
26	26
27		-=== 3.2 Store for Design ===
	31	+In this microlearning, we will focus on how you can upgrade your build numbers within eMagiz consistently and easily. Knowing how to upgrade your build numbers will ensure that you will keep your eMagiz solution as up to date as possible and therefore also as stable and secure as possible. Within this section of the microlearning we will take a look at the three key consideration when updating build numbers:
28	28
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.
	33	+* Why should I upgrade my build numbers?
	34	+* How do I determine which of my flows can be updated with ease?
	35	+* How should I handle the build number upgrade?
30	30
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.
	37	+=== 3.1 Why should I upgrade my build numbers? ===
32	32
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
	39	+Build numbers govern all dependencies to other open-source software and govern the ability to use new functionality on flow level within the portal. Therefore by consistently upgrading your build numbers, you ensure that you keep up to date with all the dependencies. This not only prevents surprises when you did not migrate for a long time but also ensures that you are working on the most secure piece of software that is available. Furthermore, by upgrading your build numbers you will unlock the use of new functionality on flow level and you will prevent that you will run into problems because we have stopped supporting certain build numbers.
36	36
37		-=== 3.3 Store for Capture ===
	41	+All in all enough reasons to keep a regular pace to upgrade your build numbers.
38	38
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.
	43	+=== 3.2 How do I determine which of my flows can be updated with ease? ===
40	40
41		-=== 3.4 Content Management for Store items ===
	45	+The first trigger will be in the release notes in eMagiz [[Buildnumber release notes>>doc:Main.Release Information.Build numbers.WebHome||target="blank"]] and the release blog that is written with every release. Here you can read why a new build number is introduced. Is it because of new functionality, did we update some of the underlying (open source) software or a combination of multiple factors? By reading the release notes you can also easily determine what the possible impact is on your eMagiz solution. For example, if the only change in build number is that a specific component is added or changed and you do not use that (or only limited) the impact is also limited.
42	42
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.
	47	+As you can already imagine, this judgment call becomes much tougher when you are 10 versions behind compared to when you are 1 or 2 versions behind. Simply because there is less of a gap to identify and analyze. So keep your eye on the release notes and release blog.
44	44
45		-=== 3.5 Licensing Store ===
	49	+Now that you know that there is a new build number and what is exactly changed you can start comparing your current release state to the desired release state (i.e. all flows on the latest build number). You can do this with relative ease with the help of the compare functionality in Deploy -> Releases. As the help infographic on this page tells us you can determine what is changed with the help of how eMagiz color codes the various flows:
46	46
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.
	51	+[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-upgrading-build-numbers--release-compare-legend.png]]
48	48
49		-The disclaimer for using Store content can be found here:
	53	+As you can see, when a flow indicates a blue dotted line it means the only change between your Create flow and the flow within your release is the build number. These flows are excellent candidates to upgrade as there are no functional changes to consider.
50	50
	55	+[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-upgrading-build-numbers--release-comparison.png]]
	56	+
	57	+Note that when you are dealing with a functional change in a flow you should consider what the impact would be if you upgrade the flow to the latest build number. Simply because upgrading to the latest build number automatically means upgrading to the latest flow version (regardless of whether functional changes have occurred). If the flow is still in development and not part of a Production (or Acceptance) release there is nothing to worry about as you will use the latest flow version anyway to test your functionality and move it to Production (or Acceptance) at a later stage.
	58	+
	59	+However, when a functional change has occurred and the older flow is running on Production (or Acceptance) you should make a deliberate choice whether or not to move that flow to the latest build number. Once again the decision will become far more complicated when you are a lot of build numbers behind as that might mean that other flows on the same runtime are also not eligible to be upgraded. So once again keep your build numbers updated.
	60	+
	61	+When you can upgrade all flow versions to the latest version eMagiz provides you with a button that will automatically do this for you. This prevents you from clicking through the release several hundred times. If you access the context menu of your release you will see the option called Update flows to the latest version. Pressing this button will automatically upgrade all flows that are part of the release to the latest version.
	62	+
	63	+[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-upgrading-build-numbers--update-flows-to-latest-version.png]]
	64	+
	65	+After you are satisfied with how the release looks you should make it active via the option called Set Release as Active.
	66	+
	67	+[[image:Main.Images.Microlearning.WebHome@novice-lifecycle-management-upgrading-build-numbers--release-comparison-after-update.png]]
	68	+
	69	+=== 3.3 How should I handle the build number upgrade? ===
	70	+
	71	+The reason why you should set your release as Active instead of deploying instantaneously is two-fold:
	72	+
	73	+* As this will impact the complete environment you should communicate and plan a correct date and time to execute the upgrade
	74	+* Using the deploy functionality to upgrade your complete project is not considered best practice
	75	+
	76	+Now that you have made the release active you can upgrade your complete project in the following way:
	77	+
	78	+* Stop all entries to ensure that no data is flowing to your project in the midst of upgrading your complete project
	79	+* Ensure that you have disabled all alerting
	80	+* Upgrade the JMS by installing the new deployment package and starting the new flow.
	81	+* Ensure that all other runtimes get stopped, data folder removed (excluding the h2 part), and get started again
	82	+
	83	+By using that logic eMagiz will forget which flows were running on the runtime and the start-up will ask the portal which flows should run. Because you have made the new release active this means that automatically the new and correct flows will be installed and started by eMagiz.
	84	+
	85	+Note that for cloud runtimes you can combine this with a cloud template upgrade or by using the Reset functionality offered by eMagiz in Deploy -> Architecture. Note that for on-premise runtimes you will have to do these steps manually.
	86	+
	87	+When you are finished with all runtimes navigate back to the Releases overview in Deploy and press the Deploy icon to activate your deployment plan. This is a great way to ensure that you did not accidentally miss one or more flows and will automatically ensure that the eMagiz alerting is activated again (assuming you make use of the best practices of eMagiz).
	88	+
51	51	== 4. Assignment ==
52	52
53		-There is no assignment for this microlearning. Please refer to the next microlearning in this module so that you can experience it properly.
	91	+Read up on the release notes of the build numbers and determine for the projects in which you operate what the status is of your eMagiz solution on the eMagiz platform.
54	54
55	55	== 5. Key takeaways ==
56	56
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.
	95	+* Make your life easier by keeping up to date with regards to the build numbers that eMagiz releases
	96	+* Determine the impact of the build number upgrade based on the release notes and the comparison functionality
	97	+* Communicate before executing the upgrade
	98	+* Ensure that data traffic is limited (or even better halted) during the upgrade
	99	+* Verify your work by running the deployment plan
59	59
60	60	== 6. Suggested Additional Readings ==
61	61
...	...	@@ -63,7 +63,7 @@
63	63
64	64	== 7. Silent demonstration video ==
65	65
66		-There is no demonstration video of this functionality.)))
	107	+As this is a more theoretical microlearning we have no video for this)))
67	67
68	68	((({{toc/}}))){{/container}}
69	69	{{/container}}