Settings - eMagiz

(((

In this microlearning, we'll explore the various settings within the Design phase of eMagiz and how they shape your integration model's structure. Settings are crucial configuration items that determine how your model is set up, including technical names, deployment locations, and system redundancies. Understanding and correctly configuring these settings will ensure your model runs smoothly and efficiently, adapting as your integration landscape grows.

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

12

== 2. Key concepts ==

13

14

This microlearning centers around the Settings in Design

15

16

With settings we mean: A set of configuration items that define how the setup of the model will look like.

The settings define:

* Technical name

* Namespace URL

* Enforce CDM best practices

23

* Nr. of process containers

24

* IaaS where is your eMagiz model deployed)

* Use failover

* Use cluster

* Connection type

== 3. Settings ==

In this microlearning, we will discuss how to configure the settings to represent the correct structure of how your model will be running.

32

33

eMagiz will fill in several settings for you and those you don't need to change. These settings are:

34

35

* Enforce CDM best practices

* Use cluster

* Connection type

The other settings can be divided into two segments. The first segment defines settings that you need to set once and never have to change anymore.

40

Under this segment we define the following settings:

* Technical name

* Namespace URL

The second segment defines settings that might change over time as your integration landscape is growing which leads to different choices:

46

47

* Nr. of process containers

48

* IaaS (where is your eMagiz model deployed)

49

* Use failover

50

51

Editing either one of these settings can be done via the Edit Settings button:

52

53

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--edit-project-settings.png]]

54

55

=== 3.1 Generic Settings ===

56

57

The generic settings that need to be defined once are the technical name and the namespace URL.

58

The advice is to shorten your display name to seven characters to represent the technical name and let the namespace URL reflect what your eMagiz model is about (i.e name of a business, organizational unit, etc.).

59

60

An example of such a implementation would be:

61

62

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--generic-project-settings.png]]

63

64

=== 3.2 Specific Settings ===

65

66

The specific settings could change over time as your integration landscape is growing leading to other decisions being made.

67

Let us take a look at each of these settings one by one to see what they are about and how they can change over time.

68

69

==== 3.2.1 Nr. of process containers ====

70

71

The number of process containers defines how many runtimes will be used to run your core flows (i.e. onramp, offramp, routing, error).

72

The default setting is 1 process container.

73

74

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--number-of-process-containers.png]]

75

76

However the moment your integration landscape grows beyond a certain number of flows you should think about dividing the load between multiple process containers.

77

The current limit we advise is a maximum of 60 flows per process container.

==== 3.2.1 IaaS ====

We offer two choices when it comes to where you are deploying your integration (eMagiz Cloud in AWS or On-premise). The third option (Root) is deemed end of life

82

83

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--IaaS-options.png]]

84

85

The best practice for test models and academy-related models is to run them on-premise (meaning in this case your laptop).

86

The best practice for actual models is to run them in the eMagiz Cloud (AWS)

87

88

==== 3.2.1 Use failover ====

89

90

The third setting that could change over time is the setting to use a failover or not.

91

92

Using failover will add high availability and redundancy of the JMS servers to the solution, but also requires more hardware to deploy on.

93

Note that in most cases using failover with only a single process container is not very useful, as this makes the process container the single point of failure.

94

95

This means that you have to decide whether your model should be always up and running (also in case of trouble on one of the JMS servers) or if it is okay that downtime can occur in those situations.

96

Furthermore, it means that this setting also impacts the setting for the nr. of process containers.

97

98

If you use failover and have less than 60 flows you should have 2 process containers.

99

If you have between 60-120 flows and use failover you should have 4 process containers. As you can imagine the logic continues onwards if you continue to grow.

100

101

=== 3.3 Applying Settings ===

102

103

The moment you are satisfied with your settings you need to apply the settings for the Design Architecture to reflect your choices.

104

The first time you set up these settings you can press the Apply Settings button in this overview as it will immediately apply the settings to Test, Acceptance, and Production.

105

106

However, the moment you are already running your eMagiz integration landscape on these environments on Test, Acceptance, and Production

107

we strongly advise that you apply the change in settings **per** environment.

108

109

You can apply these settings **per** environment via the Design Architecture overview by selecting the option Apply settings.

110

111

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--apply-settings-design-architecture.png]]

112

113

=== 3.4 Transfer settings to Create ===

114

115

Furthermore, the moment you change your settings **after** you have transferred at least one flow to Create you should also update the settings in Create to reflect the new reality.

116

You can do so by navigating to Create -> Settings -> Transfer Settings from Design.

117

118

If there are differences in one of the specified categories you should press the Transfer button to sync Design and Create.

119

120

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--transfer-settings-from-design.png]]

121

122

Be aware that changing these settings can have an impact on a multitude of flows, therefore proceed with caution and be patient to see results

123

124

== 4. Key takeaways ==

125

126

* Some settings need to be defined once

127

** Technical name

128

** Namespace URL

129

* Other settings can change over time

130

** Nr. of process containers

131

** IaaS

132

** Use failover

133

* Applying them should be done with caution and with reason

134

135

== 5. Suggested Additional Readings ==

136

137

* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]

138

** [[eMagiz Architecture (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome||target="blank"]]

139

* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]

140

** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]

141

*** [[Understanding Design Architecture - Basic (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic||target="blank"]]

142

** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]

143

*** [[Finishing the Design Phase (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-finishing-the-design-phase.WebHome||target="blank"]]

144

*** [[Storing Metadata - Design Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-storing-metadata||target="blank"]]

145

* [[Design Settings (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=1%2FMain.eMagiz+Academy.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22design+settings%22||target="blank"]]

)))

(((

)))

author	version	line-number	content
		1	{{container}}
		2	{{container layoutStyle="columns"}}
		3	(((
		4	In this microlearning, we'll explore the various settings within the Design phase of eMagiz and how they shape your integration model's structure. Settings are crucial configuration items that determine how your model is set up, including technical names, deployment locations, and system redundancies. Understanding and correctly configuring these settings will ensure your model runs smoothly and efficiently, adapting as your integration landscape grows.
		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
		12	== 2. Key concepts ==
		13
		14	This microlearning centers around the Settings in Design
		15
		16	With settings we mean: A set of configuration items that define how the setup of the model will look like.
		17
		18	The settings define:
		19
		20	* Technical name
		21	* Namespace URL
		22	* Enforce CDM best practices
		23	* Nr. of process containers
		24	* IaaS where is your eMagiz model deployed)
		25	* Use failover
		26	* Use cluster
		27	* Connection type
		28
		29	== 3. Settings ==
		30
		31	In this microlearning, we will discuss how to configure the settings to represent the correct structure of how your model will be running.
		32
		33	eMagiz will fill in several settings for you and those you don't need to change. These settings are:
		34
		35	* Enforce CDM best practices
		36	* Use cluster
		37	* Connection type
		38
		39	The other settings can be divided into two segments. The first segment defines settings that you need to set once and never have to change anymore.
		40	Under this segment we define the following settings:
		41
		42	* Technical name
		43	* Namespace URL
		44
		45	The second segment defines settings that might change over time as your integration landscape is growing which leads to different choices:
		46
		47	* Nr. of process containers
		48	* IaaS (where is your eMagiz model deployed)
		49	* Use failover
		50
		51	Editing either one of these settings can be done via the Edit Settings button:
		52
		53	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--edit-project-settings.png]]
		54
		55	=== 3.1 Generic Settings ===
		56
		57	The generic settings that need to be defined once are the technical name and the namespace URL.
		58	The advice is to shorten your display name to seven characters to represent the technical name and let the namespace URL reflect what your eMagiz model is about (i.e name of a business, organizational unit, etc.).
		59
		60	An example of such a implementation would be:
		61
		62	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--generic-project-settings.png]]
		63
		64	=== 3.2 Specific Settings ===
		65
		66	The specific settings could change over time as your integration landscape is growing leading to other decisions being made.
		67	Let us take a look at each of these settings one by one to see what they are about and how they can change over time.
		68
		69	==== 3.2.1 Nr. of process containers ====
		70
		71	The number of process containers defines how many runtimes will be used to run your core flows (i.e. onramp, offramp, routing, error).
		72	The default setting is 1 process container.
		73
		74	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--number-of-process-containers.png]]
		75
		76	However the moment your integration landscape grows beyond a certain number of flows you should think about dividing the load between multiple process containers.
		77	The current limit we advise is a maximum of 60 flows per process container.
		78
		79	==== 3.2.1 IaaS ====
		80
		81	We offer two choices when it comes to where you are deploying your integration (eMagiz Cloud in AWS or On-premise). The third option (Root) is deemed end of life
		82
		83	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--IaaS-options.png]]
		84
		85	The best practice for test models and academy-related models is to run them on-premise (meaning in this case your laptop).
		86	The best practice for actual models is to run them in the eMagiz Cloud (AWS)
		87
		88	==== 3.2.1 Use failover ====
		89
		90	The third setting that could change over time is the setting to use a failover or not.
		91
		92	Using failover will add high availability and redundancy of the JMS servers to the solution, but also requires more hardware to deploy on.
		93	Note that in most cases using failover with only a single process container is not very useful, as this makes the process container the single point of failure.
		94
		95	This means that you have to decide whether your model should be always up and running (also in case of trouble on one of the JMS servers) or if it is okay that downtime can occur in those situations.
		96	Furthermore, it means that this setting also impacts the setting for the nr. of process containers.
		97
		98	If you use failover and have less than 60 flows you should have 2 process containers.
		99	If you have between 60-120 flows and use failover you should have 4 process containers. As you can imagine the logic continues onwards if you continue to grow.
		100
		101	=== 3.3 Applying Settings ===
		102
		103	The moment you are satisfied with your settings you need to apply the settings for the Design Architecture to reflect your choices.
		104	The first time you set up these settings you can press the Apply Settings button in this overview as it will immediately apply the settings to Test, Acceptance, and Production.
		105
		106	However, the moment you are already running your eMagiz integration landscape on these environments on Test, Acceptance, and Production
		107	we strongly advise that you apply the change in settings per environment.
		108
		109	You can apply these settings per environment via the Design Architecture overview by selecting the option Apply settings.
		110
		111	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--apply-settings-design-architecture.png]]
		112
		113	=== 3.4 Transfer settings to Create ===
		114
		115	Furthermore, the moment you change your settings after you have transferred at least one flow to Create you should also update the settings in Create to reflect the new reality.
		116	You can do so by navigating to Create -> Settings -> Transfer Settings from Design.
		117
		118	If there are differences in one of the specified categories you should press the Transfer button to sync Design and Create.
		119
		120	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-project-settings--transfer-settings-from-design.png]]
		121
		122	Be aware that changing these settings can have an impact on a multitude of flows, therefore proceed with caution and be patient to see results
		123
		124	== 4. Key takeaways ==
		125
		126	* Some settings need to be defined once
		127	** Technical name
		128	** Namespace URL
		129	* Other settings can change over time
		130	** Nr. of process containers
		131	** IaaS
		132	** Use failover
		133	* Applying them should be done with caution and with reason
		134
		135	== 5. Suggested Additional Readings ==
		136
		137	* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome\|\|target="blank"]]
		138	** [[eMagiz Architecture (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-architecture.WebHome\|\|target="blank"]]
		139	* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome\|\|target="blank"]]
		140	** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome\|\|target="blank"]]
		141	*** [[Understanding Design Architecture - Basic (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic\|\|target="blank"]]
		142	** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome\|\|target="blank"]]
		143	*** [[Finishing the Design Phase (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-finishing-the-design-phase.WebHome\|\|target="blank"]]
		144	*** [[Storing Metadata - Design Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-storing-metadata\|\|target="blank"]]
		145	* [[Design Settings (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=1%2FMain.eMagiz+Academy.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22design+settings%22\|\|target="blank"]]
		146	)))
		147
		148	(((
		149	{{toc/}}
		150	)))
		151	{{/container}}
		152	{{/container}}

Wiki source code of Settings

Navigation