Getting Started

This guide walks through the first local build workflow for iFlowKit Core.

Prerequisites

Install the following tools:

• Java 17
• Gradle
• Git

The repository is configured for SAP CPI compatibility:

Setting	Value
Groovy compiler	2.4.21
Java toolchain	17
Bytecode target	release 8

Clone the repository

git clone https://github.com/iflowkit/iflowkit.git
cd iflowkit

If your repository URL is different, use your actual GitHub repository address.

Build a sample package

The sample package in the repository is iflowkit-email.

gradle clean buildPkg -Ppkg=iflowkit-email

The output is written under:

build/libs/{jarName}-{version}.jar

For the sample package, the JAR metadata is driven by packages/iflowkit-email/iflowkit/package.json.

Run buildSrc tests

gradle :buildSrc:test

Understand the package manifest

Every package has a manifest:

packages/{pkg}/iflowkit/package.json

The manifest declares:

• package name, version and vendor
• included systems and services
• included plugins and plugin parameters
• expected credential definitions

Example:

{
  "name": "iFlowKit-Email",
  "version": "1.0.15",
  "vendor": "iFlowKit",
  "systems": {
    "outlook": { "services": ["Mail"] }
  },
  "plugins": {
    "email": {
      "id": "com.iflowkit.plugin.email",
      "parameters": {
        "defaultSenderAddress": "no-reply@iflowkit.local"
      }
    }
  }
}

Next steps

• Learn the repository structure.
• Review package and manifest concepts.
• Read the Email package reference.