Configure an integration

(((

This microlearning focuses on configuring integrations within the eMagiz platform. An integration refers to the method of exchanging data between an external party and eMagiz based on specific rules and definitions. In this guide, we will walk you through the steps to add, edit, and delete integrations, ensuring that your data exchanges are set up as intented.

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 configuring an integration.

15

With configuration we mean: Adding, Editing, and/or Deleting an integration.

16

With integration we mean: A method to exchange data between an external party and eMagiz based on agreed-upon rules and definitions.

17

18

To configure an integration you need the following:

19

20

* Connection information (how are you going to exchange information)

21

* Content information (what are you going to exchange)

22

* Security information (how are you going to secure the data exchange)

23

24

== 3. Configure an integration ==

25

26

As specified before with configure we refer to adding, editing, and/or deleting an integration. Below we will explain the steps in detail.

27

28

=== 3.1 Adding a integration ===

29

30

To add an integration you simply drag a line from or to a system on the canvas

31

32

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--drag-message-type-on-canvas-start.png]]

33

34

After you have connected the system to eMagiz (located in the center) you will immediately be presented with the following pop-up. In this pop-up you have a choice to make:

35

36

* Re-use a message type (in case another system already supplies Orders and you want to send these Orders to another system for example)

37

* Add a new message type

38

39

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--new-message-type-first-popup.png]]

40

41

In case you want to add a new message type, please study the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-integration||target="blank"]].

42

43

In this microlearning, we will assume that the message type you want to use for this particular integration is already available within your eMagiz project.

44

Therefore we will select the message type Configure a message type from the drop-down menu.

45

46

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--select-message-type.png]]

47

48

=== 3.2 Editing a integration ===

49

50

Editing an integration can mean two things within the context of eMagiz.

51

The first time you connect a system to eMagiz it means filling in the detailed information belonging to the integration.

52

Later on, editing is keeping the information up to date when changes occur.

53

54

Providing detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.

55

This detailed information is available when you double click on the line you have just drawn (or select the Edit integration option via the context menu).

56

57

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-integration-context-menu.png]]

58

59

After you have selected the integration a pop-up will be shown. This pop-up is divided into three segments:

60

61

* General

62

* Connectivity/Security

63

* Content

64

65

==== 3.2.1 General ====

66

67

This segment answers several general questions surrounding this integration. With the help of the questions on this tab, you can set the stage in terms of the context of what the integration should do and when it is active (or not).

68

69

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-general-empty.png]]

70

71

After you have filled in the general details the information should look similar to something as depicted below

72

73

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-general-filled-in.png]]

74

75

==== 3.2.2 Connectivity/Security ====

76

77

The second segment has to do with the connectivity (i.e. how will the data be sent to eMagiz or from eMagiz to an external system) and security (i.e. how can you tell the external system to accept your data as coming from you).

78

79

In this segment you will answer questions on:

80

81

* how the messages will be send (i.e. REST web service, file drop, etc.)

82

* What are the specific connectivity details

83

* What do we know about the security of the external system

84

* Retention policy (in case of Event Streaming)

85

* GDPR

86

87

If you have filled in all this information you have learned a lot about how you need to Design and Create your integration.

88

89

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-connectivity-security.png]]

90

91

==== 3.2.3 Content ====

92

93

The third segment is focused on the content of the message.

94

Remind yourself, in the previous segment we determined the format of the message, now we can zoom in to determine the actual content of the messages that will be exchanged.

95

96

In this question you can add various documents retrieved from the external party that define how messages will be exchanged:

97

98

* Example messages (i.e. examples of what a message could look like, very useful when unit testing your flow)

99

* Definitions (i.e XSD or WSDL, that define the exact structure, order, and data types of the message)

100

* Specification Document (i.e. detailing the method of authentication, order of actions needed to successfully post a message, etc.)

101

102

You can do so by adding attachments to this specific implementation of the message type.

103

104

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--add-example-message-attachment.png]]

105

106

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--add-xsd-attachment.png]]

107

108

All attachments linked to this specific implementation of the message type are shown in a grid on this third segment.

109

110

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--message-content-overview.png]]

111

112

Note that you could also add additional remarks in this segment to provide even more context to those that will be actually building the integration.

113

114

=== 3.3 Deleting a integration ===

115

116

Deleting an integration can be done with the help of the context menu on integration level.

117

If you right-click on the line you have just finished you will see an option Delete Integration.

118

Selecting that option will delete your integration.

119

120

[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--delete-integration.png]]

121

122

Be aware that you can only delete an integration if the integration is not part of the Create phase (anymore).

123

124

== 4. Key takeaways ==

125

126

* A integration refers to a specific implementation between a specific external party and eMagiz based on a message type (data object)

127

* Several integrations can re-use the same message type

128

* Filling in the detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.

129

* Deleting an integration can only be done **after** the integration has been untransferred from Create (or never existed in Create in the first place)

130

131

== 5. Suggested Additional Readings ==

132

133

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

134

** [[Discovery (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-discovery.WebHome||target="blank"]]

135

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

136

** [[Designing An Event Stream (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-designing-a-event-stream||target="blank"]]

137

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

138

** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome||target="blank"]]

139

*** [[Cleanup a captured integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.novice-lifecycle-management-cleanup-a-captured-integration.WebHome||target="blank"]]

140

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

141

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

142

*** [[Configure a message type (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-message-type||target="blank"]]

143

* [[Integration (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=%22integration%22||target="blank"]]

)))

(((

)))

author	version	line-number	content
		1	{{container}}
		2	{{container layoutStyle="columns"}}
		3	(((
		4	This microlearning focuses on configuring integrations within the eMagiz platform. An integration refers to the method of exchanging data between an external party and eMagiz based on specific rules and definitions. In this guide, we will walk you through the steps to add, edit, and delete integrations, ensuring that your data exchanges are set up as intented.
		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 configuring an integration.
		15	With configuration we mean: Adding, Editing, and/or Deleting an integration.
		16	With integration we mean: A method to exchange data between an external party and eMagiz based on agreed-upon rules and definitions.
		17
		18	To configure an integration you need the following:
		19
		20	* Connection information (how are you going to exchange information)
		21	* Content information (what are you going to exchange)
		22	* Security information (how are you going to secure the data exchange)
		23
		24	== 3. Configure an integration ==
		25
		26	As specified before with configure we refer to adding, editing, and/or deleting an integration. Below we will explain the steps in detail.
		27
		28	=== 3.1 Adding a integration ===
		29
		30	To add an integration you simply drag a line from or to a system on the canvas
		31
		32	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--drag-message-type-on-canvas-start.png]]
		33
		34	After you have connected the system to eMagiz (located in the center) you will immediately be presented with the following pop-up. In this pop-up you have a choice to make:
		35
		36	* Re-use a message type (in case another system already supplies Orders and you want to send these Orders to another system for example)
		37	* Add a new message type
		38
		39	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--new-message-type-first-popup.png]]
		40
		41	In case you want to add a new message type, please study the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-integration\|\|target="blank"]].
		42
		43	In this microlearning, we will assume that the message type you want to use for this particular integration is already available within your eMagiz project.
		44	Therefore we will select the message type Configure a message type from the drop-down menu.
		45
		46	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--select-message-type.png]]
		47
		48	=== 3.2 Editing a integration ===
		49
		50	Editing an integration can mean two things within the context of eMagiz.
		51	The first time you connect a system to eMagiz it means filling in the detailed information belonging to the integration.
		52	Later on, editing is keeping the information up to date when changes occur.
		53
		54	Providing detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.
		55	This detailed information is available when you double click on the line you have just drawn (or select the Edit integration option via the context menu).
		56
		57	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-integration-context-menu.png]]
		58
		59	After you have selected the integration a pop-up will be shown. This pop-up is divided into three segments:
		60
		61	* General
		62	* Connectivity/Security
		63	* Content
		64
		65	==== 3.2.1 General ====
		66
		67	This segment answers several general questions surrounding this integration. With the help of the questions on this tab, you can set the stage in terms of the context of what the integration should do and when it is active (or not).
		68
		69	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-general-empty.png]]
		70
		71	After you have filled in the general details the information should look similar to something as depicted below
		72
		73	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-general-filled-in.png]]
		74
		75	==== 3.2.2 Connectivity/Security ====
		76
		77	The second segment has to do with the connectivity (i.e. how will the data be sent to eMagiz or from eMagiz to an external system) and security (i.e. how can you tell the external system to accept your data as coming from you).
		78
		79	In this segment you will answer questions on:
		80
		81	* how the messages will be send (i.e. REST web service, file drop, etc.)
		82	* What are the specific connectivity details
		83	* What do we know about the security of the external system
		84	* Retention policy (in case of Event Streaming)
		85	* GDPR
		86
		87	If you have filled in all this information you have learned a lot about how you need to Design and Create your integration.
		88
		89	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--edit-message-type-connectivity-security.png]]
		90
		91	==== 3.2.3 Content ====
		92
		93	The third segment is focused on the content of the message.
		94	Remind yourself, in the previous segment we determined the format of the message, now we can zoom in to determine the actual content of the messages that will be exchanged.
		95
		96	In this question you can add various documents retrieved from the external party that define how messages will be exchanged:
		97
		98	* Example messages (i.e. examples of what a message could look like, very useful when unit testing your flow)
		99	* Definitions (i.e XSD or WSDL, that define the exact structure, order, and data types of the message)
		100	* Specification Document (i.e. detailing the method of authentication, order of actions needed to successfully post a message, etc.)
		101
		102	You can do so by adding attachments to this specific implementation of the message type.
		103
		104	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--add-example-message-attachment.png]]
		105
		106	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--add-xsd-attachment.png]]
		107
		108	All attachments linked to this specific implementation of the message type are shown in a grid on this third segment.
		109
		110	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--message-content-overview.png]]
		111
		112	Note that you could also add additional remarks in this segment to provide even more context to those that will be actually building the integration.
		113
		114	=== 3.3 Deleting a integration ===
		115
		116	Deleting an integration can be done with the help of the context menu on integration level.
		117	If you right-click on the line you have just finished you will see an option Delete Integration.
		118	Selecting that option will delete your integration.
		119
		120	[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-integration--delete-integration.png]]
		121
		122	Be aware that you can only delete an integration if the integration is not part of the Create phase (anymore).
		123
		124	== 4. Key takeaways ==
		125
		126	* A integration refers to a specific implementation between a specific external party and eMagiz based on a message type (data object)
		127	* Several integrations can re-use the same message type
		128	* Filling in the detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.
		129	* Deleting an integration can only be done after the integration has been untransferred from Create (or never existed in Create in the first place)
		130
		131	== 5. Suggested Additional Readings ==
		132
		133	* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome\|\|target="blank"]]
		134	** [[Discovery (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-discovery.WebHome\|\|target="blank"]]
		135	* [[Crash Course Event Streaming (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.WebHome\|\|target="blank"]]
		136	** [[Designing An Event Stream (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-designing-a-event-stream\|\|target="blank"]]
		137	* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome\|\|target="blank"]]
		138	** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.WebHome\|\|target="blank"]]
		139	*** [[Cleanup a captured integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Lifecycle Management.novice-lifecycle-management-cleanup-a-captured-integration.WebHome\|\|target="blank"]]
		140	* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome\|\|target="blank"]]
		141	** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome\|\|target="blank"]]
		142	*** [[Configure a message type (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-message-type\|\|target="blank"]]
		143	* [[Integration (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=%22integration%22\|\|target="blank"]]
		144	)))
		145
		146	(((
		147	{{toc/}}
		148	)))
		149	{{/container}}
		150	{{/container}}

Wiki source code of Configure an integration

Navigation