Skip to content

Quick start

This quick start takes you from a new InfoConnect Hub to four working results. Each part links to the detailed guide.

  1. Install and start the Hub
  2. Surface a program and a query as APIs and MCP tools
  3. Replicate IBM i data to a database
  4. Surface a green-screen script as a REST API

Parts 2 to 4 are independent. Complete part 1 first.

Install and start the Hub

Check the prerequisites first.

  1. Get the Hub distribution archive and a trial license from Infoview, or launch the Hub from a marketplace.
  2. Extract the archive into a product home directory, <hub-home>.
  3. In <hub-home>/start-scripts, start the Hub. On Windows, double-click infoconnect-hub.bat. On Linux and macOS, run:

    bash infoconnect-hub.sh
    
  4. On the first launch, answer the two prompts: first the credentials, then the modules to start.

  5. Open http://localhost:8085 and sign in with the UI credentials from step 4.
  6. Create a connection to your IBM i system: click Connections, click Create New Connection, choose Native Connection, enter the Connection name, the Endpoint, the User Id and the Password, and click Submit.

Warning

The stand-alone distribution requires a valid license. Install your license before you create connections, see License management.

For other deployment options (Windows and Linux services, Docker, Kubernetes, clusters), see Installation.

Surface a program and a query as APIs and MCP tools

Surface an SQL query as a Data API:

  1. Click APIs, click Create API, click Create Data API, and select your connection.
  2. Enter a Data API Definition Name, an SQL Statement such as SELECT * FROM MYLIB.CUSTOMERS, and a URI such as /api/customers. In Supported Http verbs, select GET.
  3. Click Submit.
  4. Open the API in the API List, click Execute Data API, and click Execute. If Execute Data API is disabled, the API is inactive: click Activate first.

Surface an IBM i program as a Program Call:

  1. Click APIs, click Create API, click Create Program Call, and select your connection.
  2. In Main Configuration, enter the Program Definition Name, the program name and library, and the URI.
  3. In Program Call Parameters, click Add parameter and define each parameter with its name, Data type, length, Usage and Source field name.
  4. Click Submit, then run the API with Execute Program Call.

Use the APIs as MCP tools: the MCP server turns each API into an MCP tool. In your AI client, add a custom MCP server of type streamable-http with the URL http://localhost:8083/api/mcp.

More: Data API, Program Call, API and MCP enablement, AI and MCP tutorial.

Replicate IBM i data to a database

Before you start, install InfoCDC and add a table, as described in the change data capture quick start. You also need a target database with its JDBC URL, user and password. See the supported databases.

  1. Click Data Flows, click Create Data Flow, choose Outbound (IBM i to cloud services), and select your connection.
  2. Enter a Data Flow Name, and the Source data queue name and Library name of the InfoCDC data queue. Leave the format file fields at their default value auto.
  3. In Sink Settings, select the Sink Type JDBC and enter the Driver Class Name, the JDBC URL, the Username and the Password. All four are required.
  4. Click Submit. Open the Data Flow from the Data Flows list and click Start.

By default, the Hub creates the target tables automatically. More: IBM i data replication to databases, Data Flows, Data Flow states and errors.

Surface a green-screen script as a REST API

Screen automation needs the RPA Hub module. Make sure that you started it, see Installation.

  1. Click Connections, click Create New Connection, and choose Screen Automation Connection. Enter the Connection name, Host, Port, Username and Password, and the row and column positions of the user name and password fields on the sign-on screen. In Initial Key String, enter the keystrokes that open your starting screen. Click Submit.
  2. Click APIs, click Create API, click Create RPA Call, and select the Screen Automation Connection.
  3. Enter the RPA Call Definition Name and the URI. In Key String, enter the keystrokes of your script. Mark input variables with :<name>, for example [pf5],[tab],2,[enter],:<orderStatus>,[enter], and define orderStatus as an input parameter in RPA Call Parameters.
  4. Click Submit, then run the API with Execute RPA Call.

More: Screen Automation Connection form, RPA Call, RPA Hub user guide.

Next steps