IBM i2 Analyze Connector Developer Guide

This guide explains how to develop connectors for IBM i2 Analyze, including connecting to external data sources and implementing configuration and acquire…


IBM i2 Analyze Connector Developer Guide - cover page
Brand
IBM
Document type
User Manual
Language
English
Pages
16
File format
PDF
File size
327 KB
Published
17 October, 2026
Updated
17 October, 2026
MD5 checksum
B71CEDC35E341E5F63E2EFD5331C6E0A

About this manual

This document provides guidance on developing custom connectors for the IBM i2 Analyze platform. It details the architecture of i2 Connect solutions, which use a gateway to manage connections between i2 Analyze and external data sources via REST interfaces.

The guide covers the process of creating connectors that enable users to query and retrieve data from external stores. Key topics include writing parameterless queries for initial testing, extending the i2 Analyze schema to accommodate new entity types, and implementing mandatory acquire endpoints as well as optional configuration and validate endpoints.

What's inside

  • Connecting to external data sources
  • Architecture of i2 Connect solutions
  • Creating a connector for i2 Connect
  • Writing a parameterless query
  • Extending the i2 Analyze schema
  • Implementing a configuration endpoint
  • Adding a connector to the topology
  • Implementing an acquire endpoint
  • Starting and testing a connector

Frequently asked questions

What is the role of the i2 Connect gateway?

The gateway provides i2 Analyze with information about available connectors and services, retrieves service definitions from all known connectors, and ensures calls to and responses from services are formatted correctly.

What are the mandatory endpoints for a connector?

Every connector must implement an acquire endpoint. Additionally, it must have at least one service that implements both the validate and acquire endpoints.

Download PDF (327 KB)

More IBM Manuals


View all IBM manuals →