Wiki source code of Configure a message type
Last modified by Erik Bakker on 2023/01/24 15:00
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{container}}{{container layoutStyle="columns"}}((( | ||
2 | |||
3 | In this microlearning, we will focus on learning how to configure a message type. | ||
4 | Configuring a message type is the second step in designing an integration within eMagiz | ||
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 a message type. | ||
15 | With configuration we mean: Adding, Editing, and/or Deleting a message type | ||
16 | By message type we mean: A reference to a specific data object (Order, Status, Employee, Invoice, etc.) of the data that needs to be exchanged. | ||
17 | This specific data object can be exchanged between several parties, meaning a message type can be in multiple integrations within your landscape. | ||
18 | |||
19 | To configure a message type you need the following: | ||
20 | |||
21 | * The name of the message type | ||
22 | * Basic information about the message type | ||
23 | |||
24 | == 3. Configure a message type == | ||
25 | |||
26 | As specified before with configure we refer to adding, editing, and/or deleting a message type. Below we will explain the steps in detail. | ||
27 | |||
28 | === 3.1 Adding a message type === | ||
29 | |||
30 | To add a message type 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 this case, we will choose the option New message type. Selecting this option will lead to a second pop-up | ||
42 | |||
43 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--new-message-type-second-popup.png]] | ||
44 | |||
45 | In this pop-up, you need to fill in the correct details regarding your message type. The critical ones are: | ||
46 | |||
47 | * Display name | ||
48 | * Technical name | ||
49 | * Default integration pattern (coupled with Asynchronous) | ||
50 | |||
51 | While the first two are critical because you need a unique name within your eMagiz project to prevent errors, the other information element is interesting for a different reason. | ||
52 | |||
53 | This information element is a good first step in determining which integration pattern to use when dealing with this data. | ||
54 | |||
55 | See the example below on how to register this information correctly. | ||
56 | |||
57 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--new-message-type-second-popup-filled-in.png]] | ||
58 | |||
59 | If you are satisfied with your work you can press Save. This action will lead you back to the first pop-up with a distinctive difference, the message type is filled in. | ||
60 | |||
61 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--new-message-type-first-popup-filled-in.png]] | ||
62 | |||
63 | If everything is okay you can press Save and as a result, eMagiz will update the Capture overview. | ||
64 | |||
65 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--updated-capture-overview.png]] | ||
66 | |||
67 | ==== 3.2.2 Editing a message type ==== | ||
68 | |||
69 | To edit this general set of information on message type level navigate to **Capture -> Settings -> Message Types**. In this overview, you see all message types related to your eMagiz project. | ||
70 | Here you can search for the message type you want to Edit, select it and press Edit. | ||
71 | |||
72 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--edit-message-type-in-message-type-overview.png]] | ||
73 | |||
74 | Here you can change the information you have first submitted when you created a new message type. | ||
75 | A message type can be re-used over multiple integrations (lines in Capture) so be careful what you change here as it will automatically update the information on the integration level. | ||
76 | |||
77 | {{warning}}Furthermore, we strongly advise **not** to change the name (technical and functional) of a message type the moment you have already transferred one (or more) integration(s) that make use of this message type to Create.{{/warning}} | ||
78 | |||
79 | === 3.3 Deleting a message type === | ||
80 | |||
81 | Deleting a message type can be done after you have deleted all integrations that make use of the message type. | ||
82 | Therefore to delete a message type you first need to delete all the integrations (lines) in Capture that use this message type. | ||
83 | |||
84 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--delete-integration.png]] | ||
85 | |||
86 | Be aware that you can only delete an integration if the integration is not part of the Create phase (anymore). | ||
87 | |||
88 | After you have done this you can navigate to **Capture -> Settings -> Message Types**. In this overview, you see all message types related to your eMagiz project. | ||
89 | Here you can search for the message type you want to Delete, select it, and press Delete. | ||
90 | |||
91 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--message-type-overview.png]] | ||
92 | |||
93 | If you have deleted all integrations correctly the message type will be removed. | ||
94 | |||
95 | == 4. Key takeaways == | ||
96 | |||
97 | * A message type refers to a specific data object that you want to exchange between parties | ||
98 | * Several integrations can re-use the message type | ||
99 | * Editing information on message type level also edits information on integration level | ||
100 | * Deleting a message type can only be done **after** all integrations have been deleted. | ||
101 | |||
102 | == 5. Suggested Additional Readings == | ||
103 | |||
104 | If you are interested in this topic and want more information on it please read the help text provided by eMagiz. | ||
105 | |||
106 | )))((({{toc/}}))){{/container}}{{/container}} |