Welcome
Welcome to the documentation for the i2 Connect Node SDK.
At this version of the SDK, the documentation includes information on how to start developing and deploying connectors, alongside the sample projects and the API reference.
To view the API documentation for the connector server, use the Server API tab at the top of the page. You can get started with the sample projects from the main branch of this repository.
Compatibility
Each new version of the i2 Connect Node SDK adds features and functionality. The following table shows the relationship between a version of the SDK and the version of i2 Analyze in which its new features are available:
| i2 Connect Node SDK version | i2 Analyze version |
|---|---|
| 1.1 and earlier | 4.3.4.0 |
| 1.2 | 4.3.5.0 |
| 2.0 | 4.3.5.3 |
| 2.1 | 4.4.0.0 |
| 2.2 | 4.4.1.0 |
| 2.3 | 4.4.2.0 |
Note: This documentation applies to version 2.x of the SDK. You can read documentation for version 1.x of the SDK here.
Unless features are deprecated, connectors created using earlier versions of the SDK are compatible with later versions of i2 Analyze. For the best experience, keep the version of the SDK that you use for development in step with the version of the target i2 Analyze deployment.
Support policy
i2's policy for supporting releases of the SDK is as follows:
We add new functionality only to the current major version of the SDK.
On releasing a new major version, we support the previous major version for a minimum of 12 months. We consider fixes to unsupported major versions (such as updating a vulnerable dependency) on a case-by-case basis.
To deprecate something in the API, we mark it as
@deprecatedand provide instructions on the alternative to use. We remove deprecated APIs when we release the next major version of the SDK.