Integrating Adapter Within the Calibo Accelerate Platform

Prerequisites

Before you start with your adapter development work, make sure you complete the following prerequisites:

  • Ensure that the Calibo Accelerate development environment is up and running. In case of any issues, contact the Calibo DevOps team.

  • Ensure that the tenant is created and respective configurations are in place.

  • Ensure that the required roles, permissions, and users exist in the Calibo Accelerate platform.

  • Ensure that Single Sign-On (SSO) integration is done.

Development Process

The development process for adapter integration consists of the following steps:

  1. Technology Details
    The development team identifies the technology and communicates the details to the Calibo team. Adapter development team should provide the technology use cases, architecture, development approach, and test cases.

  2. Repository Setup
    The Calibo team creates a repository containing a build file, a link to download the jar with the service contract interface, and a few minimum dependencies. The master branch of this repository is managed solely by the Calibo team and can only be updated by them. The Calibo team also configures the Calibo Accelerate platform to incorporate the tool in the Cloud Platforms, Tools & Technologies section of the platform configuration.

  3. Development Branch Creation
    Development team clones the project repository and creates a development branch to start the development.

    Example
    Template Project Name - plf-appflow-adapter.
    This project has all the minimum dependencies, the service contract interface shared in a JAR file, and the required utility classes. In case of any new dependency, the development team must consult the Calibo team.

  4. Code Completion
    The development team completes the coding and commits the code.

    1. Complete the development for the required integration tool [Service implementation class and other supporting classes]

    2. Unit test cases with coverage, Dynamic Application Security Testing (DAST) and Static Application Security Testing (SAST) reports should be attached to the code commit pull requests.

    3. Integration testing with the tool should also be completed, and corresponding reports should be attached to the code commit pull request.

  5. Code Review and Merge
    The development team creates pull requests for the master branch of the repository, and the Calibo team conducts a code review before merging.

  6. Running Build Job and Building JAR File
    The Calibo team initiates the build job to generate the JAR file from the shared source code. The JAR file includes only the service implementation classes, supporting classes, and the required dependencies.

  7. Testing
    The development collaborates with the Calibo team to complete the end-to-end workflow testing of the functionality.

Related Topics Link IconRecommended Topics What's next? RDBMS Adapters