Wiki source code of Property Management

Last modified by Erik Bakker on 2024/02/20 08:32
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}
3 (((
4 In this microlearning, we will focus on the various options to create and edit properties, i.e., property management.
5
6 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7
8 == 1. Prerequisites ==
9
10 * Basic knowledge of the eMagiz platform
11 * Understanding of the concept of properties
12 * At least one flow for which you need to create a property or edit a property
13
14 == 2. Key concepts ==
15
16 This microlearning centers around property management.
17 With property management, we mean The process of creating, editing, and deletion properties based on changing circumstances (i.e., a new release).
18
19 There are several ways to manage your properties. Below we will discuss each of these steps separately.
20
21 == 3. Property Management ==
22
23 Within the eMagiz platform, you have property placeholders (i.e., the name of a property as given in Create), property configuration (i.e., on which runtime we need to configure this property), and property values. Property placeholders are generic and are re-used across releases. The specific configuration of a property (and the value) is linked to a particular release.
24
25 As a result, you can revert incorrect changes on properties by activating the previous release and deploying this. In this section, we will first focus on the property overview in Deploy. Following that, we will look at the options to add, edit and delete properties.
26
27 Once you have managed your properties and configured the values correctly for the environment, it becomes time to actualize the properties. In the following microlearnings, you can learn more about the actualization of properties:
28
29 * [[Actualize properties - current generation architecture>>doc:Main.eMagiz Academy.Microlearnings.Legacy Functionality.crashcourse-platform-deploy-actualize-properties-new.WebHome||target="blank"]]
30 * [[Actualize properties - next generation architecture>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-deploy-actualize-properties-gen3-new.WebHome||target="blank"]]
31
32 === 3.1 Property overview in Deploy ===
33
34 In the Deploy phase of eMagiz, the overview of all your properties on your environment can be found on the "Create Phase" release in Deploy -> Releases. You can access the summary by clicking on the "wrench icon." This is the main overview from which you can do property management, giving you the most functionality.
35
36 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-overview-deploy-create-phase-release.png]]
37
38 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-overview-deploy-release-overview.png]]
39
40 ==== 3.1.1 Comparing properties across environments (i.e., TAP) ====
41
42 On this level, you can also compare properties across environments. You can do this by accessing the context menu and selecting "Compare properties."
43
44 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--compare-properties-context-menu.png]]
45
46 Selecting this option will lead you to a pop-up that shows per property placeholder the relevant configuration in terms of runtimes and values.
47
48 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--compare-properties-pop-up-overview.png]]
49
50 === 3.2 Add property configurations ===
51
52 ==== 3.2.1 Default method ====
53
54 As you can see from the screenshot above, you can create properties via the New button, Edit properties via the Edit button, and Delete properties via the Delete button. To make life a little bit easier in this overview, there are various entities you can search on (i.e., Is Global, Runtime, Name, and Value)
55
56 Let us first focus on the addition of a new property. To add the property, press the "New" button. This will lead you to a new pop-up in which you can select the following items:
57
58 * Property placeholder
59 * Global property (Yes/No)
60 * Runtime(s)
61 * Value
62
63 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-new-property.png]]
64
65 We start by selecting a property placeholder. We can do this by pressing the "Select" icon after the name placeholder. Based on the properties you have included in all flows in the Create phase with a flow version, we have generated a pre-defined list of properties to select from. This avoids mismatches in naming between what is configured on the flow level and what is registered in Deploy.
66
67 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-new-property-select-property-placeholder.png]]
68
69 In the following pop-up, you can search for the property you want to configure and select it once found. After choosing the property placeholder, eMagiz will return you to the previous pop-up with the selected property placeholder filled in.
70
71 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-placeholder-filled-in.png]]
72
73 Once we have this configured, the next step would be to determine whether the property in question is global and, if not, select the relevant runtime(s) for which this property is applicable. Adding the same value for a property placeholder on multiple runtimes is helpful for larger models and those running in a double-lane setup. Instead of creating two (or more) entries for each runtime, you can configure one linked to multiple runtimes. This makes the management of properties much easier going forward.
74
75 {{info}}
76 There will be **no** automatic migration from the current situation to the new situation. As a result, you need to take steps towards this yourself when applicable.
77 {{/info}}
78
79 To select a runtime, press the "Select" icon again. However, this time after the runtime(s) placeholder. This will lead you to another pop-up that allows you to select one (or multiple runtimes) for which you want to configure the property placeholder.
80
81 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-new-property-select-runtimes.png]]
82
83 Once satisfied with your selection, you can press the "Select" button to tell eMagiz to select the runtime(s) you want. This action will return you to the "New Property" pop-up for the final part of the configuration.
84
85 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-runtimes-filled-in.png]]
86
87 In this final part of the configuration, you select the data type and fill in the correct value for the property. Once done, you can press Save to finish adding a property.
88
89 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-configuration-filled-in.png]]
90
91 After pressing Save, you will be returned to the overview with an additional property in the list.
92
93 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-overview-property-added.png]]
94
95 ==== 3.2.2 Alternative method ====
96
97 Apart from adding integrations beforehand, you can also wait until you want to activate (or deploy) your release for eMagiz to tell you which properties are missing.
98
99 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--missing-properties-overview.png]]
100
101 In this overview, you can press the "Add" button to add the relevant value for the property. Because eMagiz knows at this point which property placeholder is missing and in which runtimes it is used, these are already pre-filled in the "new property" pop-up.
102
103 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--new-properties-overview-pre-filled.png]]
104
105 Here, you can add the values as discussed above and press Save. This will return you to the "Missing properties" overview from which you can Activate your release.
106
107 {{info}}
108 Be aware that we **do not allow** that there are missing properties when activating your release on the Production environment. Consequently, we will block the activation of the release if this situation occurs.
109 {{/info}}
110
111 === 3.3 Edit property configurations ===
112
113 ==== 3.3.1 Default method ====
114
115 You can use the wrench icon on the active release when you only need to change a property value. This will show you all properties and their configuration comparable to the property management overview on the "Create phase release." There is only one distinction between the two. This property has a button in the bottom left corner called "Change properties."
116
117 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-overview-release.png]]
118
119 By clicking on this eMagiz creates what we call a "property release." This option is provided so you don't have to make and promote a new release to the specific environment. In the pop-up you see, you can edit properties to your liking, and once satisfied, press the button "Activate and deploy."
120
121 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--property-overview-release-edit-mode.png]]
122
123 {{info}}
124 Note that eMagiz will create a new release with the same name as the one you started with but with a slightly different version number. We will add a letter as a suffix to the release. This also means that when you do this four times on the same release, the suffix will be a "d."
125 {{/info}}
126
127 ==== 3.3.2 Alternative method ====
128
129 As with adding properties, you can also edit properties from the property management overview. Editing a property can be done by selecting the property you want to edit and pressing the button "Edit." This opens the same pop-up we saw before, only in this instance, everything is already filled in.
130
131 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--new-properties-overview-pre-filled.png]]
132
133 From here, you can change all the configuration options, and once done, press "Save."
134
135 === 3.4 Delete property configurations ===
136
137 ==== 3.4.1 Default method ====
138
139 In most cases, when you want to delete a property, you want to do this for the whole environment. In these cases, we navigate to Deploy -> Releases and select the wrench icon on the "Create phase" release. This will lead you to the property management overview, from which you can delete properties by selecting them and pressing the "Delete" button.
140
141 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-overview-deploy-create-phase-release.png]]
142
143 {{info}}
144 Note that no checks are done before deleting the property, so be aware of the consequences when using this option.
145 {{/info}}
146
147 ==== 3.4.2 Alternative method ====
148
149 If you only want to delete a property within the context of a release, you can do this via the wrench icon on that specific release, just as we saw in section 3.3.1 of this microlearning. By using the same functionality, you can delete the property from the release by selecting the "Delete" button and not the "Delete (including default property)."
150
151 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-deploy-property-management--properties-overview-release-delete-from-release.png]]
152
153 === 3.5 Property set to use ===
154
155 As you will only change a small portion of all the properties in your model on a specific environment, the remainder of the properties are re-used. Depending on the type of release created, the values will be re-used from a different "starting" release.
156
157 * In case you create a new functional release (including flow changes), the properties that are not changed will be re-used from the "Create phase release."
158 * If you create a new property release, the properties that are not changed will be re-used from the currently active release upon which you made the property release.
159
160 == 4. Key takeaways ==
161
162 * The property overview on the environment level can be found under the wrench icon on the "Create phase" release under Deploy -> Releases
163 * On this same level, you can compare properties across environments via the context menu
164 * For adding, editing, and deleting, there is a default and alternative method
165 * Without a flow change, you can actualize the property by activating a newly created release and stopping and starting the flow
166 * With a flow change, you can actualize the property by deploying a newly created and activated release
167
168 == 5. Suggested Additional Readings ==
169
170 If you are interested in this topic and want more information on it, please read the help text provided by eMagiz when executing these actions.
171 )))
172
173 (((
174 {{toc/}}
175 )))
176 {{/container}}
177 {{/container}}