i2 Connect example connectors

To create a connector, you need a data source to query, and a server that supports REST endpoints to query it from. On that foundation, you can build the functionality that takes requests from the i2 Connect gateway, retrieves data from the source, and returns it to the gateway in a shape that is ready for conversion to i2 Analyze records.

Developing a connector walkthrough

The documentation for understanding, deploying and configuring both i2 Analyze and an example connector is divided into the following sections:

1. Building an i2 Analyze schema and working with the i2 Connect gateway
2. Deploying i2 Analyze
3. Deploying a connector
4. Creating a service
5. Querying an external data source
6. Implementing parameterized searches
7. Implementing seeded searches
8. Implementing seeded, parameterized searches
9. Validating requests

Further materials for connector development:

• Asynchronous services
• Authentication
• User-specific configuration
• Custom HTTP headers
• Semantic seeds

Environment setup

The workshop requires the following tools and technologies:

• i2 Analyze 4.4.2: The server that hosts the i2 Connect gateway and provides the i2 Notebook web client for interacting with your connector.

• (Optionally) i2 Analyst's Notebook 10 Premium: The desktop client that provides a user interface for interacting with your connector.

  Both clients can display the resulting entity and link records with their properties.

• i2 Analyze Schema Designer: The tool that enables you to design and create your i2 Analyze schema.

• Microsoft Visual Studio Code: The recommended IDE for developing your connector. You can use any IDE you like, but VS Code has plugins that we recommend to aid in your connector deployment. Download it here.

• Postman: An API development tool that you can use to create and execute requests against REST endpoints. Download Postman here.

• An application framework dependent on the language you are writing the connector with.

  • Java (Spring Boot): The connector is written in Java with Spring Boot. Spring Boot is a Spring framework with an embedded Tomcat server that makes it easy to spin up a web application. No installation is required, but we recommend the Visual Studio Code Spring Boot Dashboard plugin, which can handle running and redeploying the connector for you.

  • Python (Flask): The Python connector is written and run on a Flask application. Flask is a micro web framework which requires no particular tools or libraries. No manual installation other than the specified setup instructions is required as the Pipfile contains it as a dependency.

Additional resources

To help you to understand some of the tools and technologies you will use, here are a few resources that contain more information about them:

• i2 Analyze data model examples
• Example requests and responses
• Using Postman
• Running the example connectors:
  • Java
  • Python
• Source identifiers
• Semantic type identifiers
• Source references
• SPI version negotiation
• Troubleshooting

Schemas and schema types

The documentation for understanding and configuring connector schemas, gateway schemas, type locations, item type mappings, and item type security is divided into the following sections:

• Connector schemas
• Gateway schemas
• Type location
• Migrating from schema fragments

The example connectors used are:

• NYPD Connector
• KCPD Connector
• ERI Connector

SPI version information

New versions of the REST SPI are always released as part of new i2 Analyze releases. Documentation for the latest version of the SPI is available through the REST SPI link at the top of the page.

SPI version 🡆 i2 Analyze version 🡇	1.0	1.1	1.2
4.4.0	✔️	❌	❌
4.4.1	✔️	✔️	❌
4.4.2	✔️	✔️	✔️

SPI changelog

• 1.0 changes
• 1.1 changes
• 1.2 changes