Wiki source code of Configure a message type
Last modified by Erik Bakker on 2024/08/18 21:27
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}} | ||
| 2 | {{container layoutStyle="columns"}} | ||
| 3 | ((( | ||
| 4 | Configuring message types is a necessary step in setting up data exchanges within the eMagiz platform. This microlearning will guide you through the process of adding, editing, and deleting message types. In this context a message type defines a specific data object like Orders or Invoices that are exchanged between systems. Understanding how to manage message types effectively ensures smooth integration across your landscape, allowing for consistent data flow and easy re-use in multiple integrations. | ||
| 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}} | ||
| 78 | 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. | ||
| 79 | {{/warning}} | ||
| 80 | |||
| 81 | === 3.3 Deleting a message type === | ||
| 82 | |||
| 83 | Deleting a message type can be done after you have deleted all integrations that make use of the message type. | ||
| 84 | Therefore to delete a message type you first need to delete all the integrations (lines) in Capture that use this message type. | ||
| 85 | |||
| 86 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--delete-integration.png]] | ||
| 87 | |||
| 88 | Be aware that you can only delete an integration if the integration is not part of the Create phase (anymore). | ||
| 89 | |||
| 90 | 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. | ||
| 91 | Here you can search for the message type you want to Delete, select it, and press Delete. | ||
| 92 | |||
| 93 | [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-capture-configure-a-message-type--message-type-overview.png]] | ||
| 94 | |||
| 95 | If you have deleted all integrations correctly the message type will be removed. | ||
| 96 | |||
| 97 | == 4. Key takeaways == | ||
| 98 | |||
| 99 | * A message type refers to a specific data object that you want to exchange between parties | ||
| 100 | * Several integrations can re-use the message type | ||
| 101 | * Editing information on message type level also edits information on integration level | ||
| 102 | * Deleting a message type can only be done **after** all integrations have been deleted. | ||
| 103 | |||
| 104 | == 5. Suggested Additional Readings == | ||
| 105 | |||
| 106 | * [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] | ||
| 107 | ** [[Discovery (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-discovery.WebHome||target="blank"]] | ||
| 108 | * [[Crash Course Event Streaming (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.WebHome||target="blank"]] | ||
| 109 | ** [[Designing An Event Stream (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-designing-a-event-stream||target="blank"]] | ||
| 110 | * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] | ||
| 111 | ** [[Discover your integration landscape (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Discover your integration landscape.WebHome||target="blank"]] | ||
| 112 | *** [[Determining Integration Pattern (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Discover your integration landscape.intermediate-discover-your-integration-landscape-determining-integration-pattern||target="blank"]] | ||
| 113 | * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] | ||
| 114 | ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]] | ||
| 115 | *** [[Configure an integration (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-capture-configure-a-integration||target="blank"]] | ||
| 116 | * [[Message Type (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=%22message+type%22||target="blank"]] | ||
| 117 | ))) | ||
| 118 | |||
| 119 | ((( | ||
| 120 | {{toc/}} | ||
| 121 | ))) | ||
| 122 | {{/container}} | ||
| 123 | {{/container}} |