

Developing Integration Solutions

The contents on this page will walk you through the topics related to developing integration solutions using ESB Integration Studio.

ESB Integration Studio

ESB Integration Studio is the comprehensive developer tool, which you will use to develop, build, and test your integration solutions before the solutions are pushed to your production environments. See the topics given below for details.

Quick Tour of ESB Integration Studio	Get introduced to the main functions of ESB Integration Studio.
Installing ESB Integration Studio	Find the instructions on how to download and install the tool on your operating system.
Troubleshooting ESB Integration Studio	Find details on how to troubleshoot errors you might encounter as you use ESB Integration Studio.

Development workflow

Integration developers will follow the workflow illustrated by the following diagram.

Set up the workspace

To start developing integration solutions, you need to first install and set up ESB Integration Studio.

Develop

• Create projects and modules

  Create an Integration project	An integration project is a maven multi module project that will include all the modules (sub projects) of your integration solution.
  Add sub projects to Integration project	Once you have created an integration project, you can add new sub projects if required.
  Move sub projects to Integration project	You can move sub projects to the required integration project from any location in the workspace.

• Create artifacts

  Message Entry Points REST API Proxy Service Inbound Endpoint Scheduled Task	Message Processing Units Message Store Message Processor Endpoint Endpoint Template Sequence Template Reusable Sequences	Registry Resources Registry Resource Local Entry Smooks
  Data Services Resources Data Service Datasource Input Validator	Custom Artifacts Custom Mediator Custom Inbound Enpoint Custom Connector Custom Scheduled Task Synapse Handler	Other Export Artifacts Import Artifacts

• Secure the artifacts

  Encrypting Sensitive Data Encrpting Secrets Docker Secrets Kubernetes Secrets Symmetric Encryption

  Securing APIs and Services Securing REST APIs Securing Proxy Services Securing Data Services

Build and run

1. Package

   The artifacts and modules should be packaged in a Composite Exporter before they can be deployed in any environment.

2. Deploy

   You can easily deploy and try out the packaged integration artifacts on your preferred environment:

   Deploy on the Embedded Micro Integrator Deploy on a Remote Micro Integrator Deploy on Docker Deploy on Kubernetes

3. Unit Tests

   Use the integration test suite of ESB Integration Studio to run unit tests on the developed integration solution.

Iterate and improve

As you build and run the integration flow, you may identify errors that need to be fixed, and changes that need to be done to the synapse artifacts.

Debug Mediations	Use the Mediation Debug function in ESB Integration Studio to debug errors while you develop the integration solutions.
Using Logs	You can enable and analyze the following logs to debug various errors: Wire Logs Proxy Service Access Logs REST API Access Logs

You must redeploy the integration artifacts after applying changes.

• If you are testing on a VM, the artifacts will be instantly deployed when you redeploy the synapse artifacts.
• If you are testing on containers, you need to rebuild the Docker images or Kubernetes artifacts.

Push to production

It is recommended to use a CICD pipeline to deploy your tested integration solutions in the production environment.

On-Premise Environment	You can easily push your integration solutions to a CICD pipeline because the developer tool (ESB Integration Studio) consists of Maven support. See the details on Integration Project.
Kubernetes Environment	If you have a Kubernetes deployment, see the instructions on how to use the Kubernetes CICD pipeline.

Related topics

Develop your first integration	Try the development workflow end-to-end by running a simple use case.
Integration Use Cases	Read about the integration use cases supported by the Micro Integrator.
Tutorials	Develop and try out each integration use case end-to-end.
Examples	Try out specific integration scenarios by running the samples.

Top