Integration Layer

Before developing an integration layer, you should ask yourself these nine questions

Abdulmohsen Alenazi
3 min readJul 11, 2021

Too many integration providers promise a simple journey to success, but in reality, this is far from what ends up happening!

A common pitfall for service providers is saying…

“I just need to integrate these systems with each other, what does it cost”

There are many things to take into consideration when thinking about the whole integration project and we want to help you identify and address these.

What are you integrating?

This is a multiple-choice question, and here are your options:

  1. Customers
  2. Service Providers
  3. Internal systems

As you know!

Integrations always have (at least) two ends. It’s important for you to understand that the complexity of the project might vary between these parties. Are you able to control both ends, does the customer or service provider have somebody from their end to work with you?

Do you have a Project Manager?

  1. We have someone in-house who runs the show
  2. The service provider or customer is providing the Project Management
  3. We are using an external provider/consultant on the project management

As you know!

Like in any project the manager plays a crucial role in the success of the end result and keeping the elements together.

What other resources will you need?

  • Tool admin?
  • Integration architect?
  • Process owner?

After you have sorted out questions 1–3, we can move forward. And now the project will be divided into two tracks. Technical and process tracks.

Let’s start with the technical track.

What systems are you looking to integrate?

  • Application 1: _________________
  • Application 2: _________________
  • Application 3: _________________
  • Application n: _________________

As you know!

The complexity of the system and depending on how sophisticated it is might have an effect on the total time and effort needed to execute the project. We have seen all kinds of interesting systems and API’s in our life.

Are your systems running in the cloud or on-premise?

  1. Cloud
  2. On-premise
  3. Both

As you know!

This might not have a direct cost related to the project, but it might slow things down. When opening firewalls and allowing IP addresses there are usually certain policies in place and those might take some time. So take this into consideration when planning the project and thinking of the timeline.

Do you have enough knowledge of the systems you are integrating with?

  1. I know my own tool
  2. I know both tools
  3. I have no knowledge of these

As you know!

It’s more of a fact than a myth that all tools and their characteristics are individual and designed in a unique way. Even if we avoid having to make changes in the corresponding systems. Sometimes you need to be able to create some triggers or web-hooks from your own system. Especially if you have something custom build.

Have you defined the use case you are looking to integrate?

  • Yes
  • No
  • Sort of (maybe you get the process, but it hasn’t translated into a genuine use case yet)

As you know!

First of all, let’s address the question: “What he** is a use case?”

Our experience shows us that the most important thing to understand is what are you looking to do. Meaning what is it that you are looking to do on a process and logical level? This is the most important part of a successful integration project and will define a lot on the length and success of the project.

Have you defined the field and value mappings?

  1. Yes, the fields and values to be mapped are clear
  2. Our site is done, waiting for the other side
  3. Nope.

As you know!

Mapping the fields and values that will be exchanged in the integration and the use case will ease the actual configuration work when setting up the integration.

Have you defined a test scenario that you are looking to run?

  1. Yes
  2. No

As you know!

When the configurations have been made to accommodate the use case, there should be testing involved. The test scenario and acceptance criteria should be agreed upon with the parties prior to knowing if the project was successful!

These questions when answered should guide you on how to start building the integration layer.

--

--

Abdulmohsen Alenazi
Abdulmohsen Alenazi

Written by Abdulmohsen Alenazi

Software Developer / Architect. Coding first 🙌🏻 GitHub: https://github.com/mohsenTalal

No responses yet