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.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
2. Key concepts
This microlearning centers around configuring an integration.
With configuration we mean: Adding, Editing, and/or Deleting an integration.
With integration we mean: A method to exchange data between an external party and eMagiz based on agreed-upon rules and definitions.
To configure an integration you need the following:
- Connection information (how are you going to exchange information)
- Content information (what are you going to exchange)
- Security information (how are you going to secure the data exchange)
3. Configure an integration
As specified before with configure we refer to adding, editing, and/or deleting an integration. Below we will explain the steps in detail.
3.1 Adding a integration
To add an integration you simply drag a line from or to a system on the canvas
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:
- Re-use a message type (in case another system already supplies Orders and you want to send these Orders to another system for example)
- Add a new message type
In case you want to add a new message type, please study the previous microlearning.
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.
Therefore we will select the message type Configure a message type from the drop-down menu.
3.2 Editing a integration
Editing an integration can mean two things within the context of eMagiz.
The first time you connect a system to eMagiz it means filling in the detailed information belonging to the integration.
Later on, editing is keeping the information up to date when changes occur.
Providing detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.
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).
After you have selected the integration a pop-up will be shown. This pop-up is divided into three segments:
- General
- Connectivity/Security
- Content
3.2.1 General
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).
After you have filled in the general details the information should look similar to something as depicted below
3.2.2 Connectivity/Security
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).
In this segment you will answer questions on:
- how the messages will be send (i.e. REST web service, file drop, etc.)
- What are the specific connectivity details
- What do we know about the security of the external system
- Retention policy (in case of Event Streaming)
- GDPR
If you have filled in all this information you have learned a lot about how you need to Design and Create your integration.
3.2.3 Content
The third segment is focused on the content of the message.
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.
In this question you can add various documents retrieved from the external party that define how messages will be exchanged:
- Example messages (i.e. examples of what a message could look like, very useful when unit testing your flow)
- Definitions (i.e XSD or WSDL, that define the exact structure, order, and data types of the message)
- Specification Document (i.e. detailing the method of authentication, order of actions needed to successfully post a message, etc.)
You can do so by adding attachments to this specific implementation of the message type.
All attachments linked to this specific implementation of the message type are shown in a grid on this third segment.
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.
3.3 Deleting a integration
Deleting an integration can be done with the help of the context menu on integration level.
If you right-click on the line you have just finished you will see an option Delete Integration.
Selecting that option will delete your integration.
Be aware that you can only delete an integration if the integration is not part of the Create phase (anymore).
4. Key takeaways
- A integration refers to a specific implementation between a specific external party and eMagiz based on a message type (data object)
- Several integrations can re-use the same message type
- Filling in the detailed information in Capture helps you to better Design, Create, Deploy and Manage your integration.
- Deleting an integration can only be done after the integration has been untransferred from Create (or never existed in Create in the first place)