LeanIX Integration

Automatically catalogue deployed CPI iFlows as fact sheets in your LeanIX workspace — with field mapping, tagging, and on-demand sync from the Runtime tab.

What It Does

LeanIX Integration connects CPI Studio to your LeanIX workspace so that every deployed iFlow can be represented as a fact sheet. This gives your enterprise architecture team a live, always-accurate inventory of your integration landscape — without manual data entry.

• Creates or updates fact sheets in LeanIX whenever you sync
• Maps any iFlow field (name, description, package, version, status…) to any LeanIX fact sheet field
• Applies configurable default tags (e.g. CPI-Managed) to every synced fact sheet
• Lets you choose the fact sheet type and optional category that best fits your LeanIX model
• Shows a LeanIX status column in the Runtime tab so you can see at a glance which iFlows are already catalogued

Prerequisites

• A LeanIX workspace with API access
• A LeanIX API token with permission to create and update fact sheets (Technical User → API Tokens in LeanIX Settings)
• The LeanIX workspace host (e.g. your-company.leanix.net)

Configuration

Open Settings → LeanIX Integration in CPI Studio.

Step 1 — Connection

Click Test Connection to verify credentials before saving. A successful test fetches your workspace metadata and populates the Fact Sheet Type dropdown.

Step 2 — Fact Sheet Type

Select the LeanIX fact sheet type to use when creating new records. Common choices:

• Application — treat each iFlow as an application (most common)
• ITComponent — treat iFlows as IT components in your technology stack
• Interface — represent each iFlow as a point-to-point interface
• DataObject — useful for data-centric integration flows

The dropdown is populated from your LeanIX workspace after a successful connection test. You can also type any type name directly if your workspace uses a custom model.

Step 3 — Category (optional)

Some fact sheet types support a category field that classifies the record within LeanIX (e.g. Interface/Messaging for ITComponent). CPI Studio fetches known categories from your workspace and shows them as suggestions in a combo-box. You can:

• Select a suggestion from the list, or
• Type any value manually — useful if your workspace uses categories not visible to the API token

Leave blank to omit the category field when creating/updating fact sheets.

Step 4 — Field Mapping

The Field Mapping section lets you control exactly which iFlow metadata lands in which LeanIX field. Each row maps one iFlow attribute to one LeanIX field path.

Common mapping examples:

name        →  /name
description →  /description
package_id  →  /displayName
Status      →  /tags (via default tag)

If no field mapping is configured, CPI Studio writes a standard metadata block to the /description field containing the iFlow name, package, tenant host, and sync timestamp.

Step 5 — Default Tags (optional)

Enter one or more tag names (e.g. CPI-Managed, SAP-Integration) to apply to every synced fact sheet. Tags must already exist in your LeanIX workspace tag library. Separate multiple tags with commas.

Step 6 — Save

Click Save Settings. Configuration is stored in leanix_config.json inside the app's data directory and is included in the Settings → Export bundle.

Syncing iFlows — Runtime Tab

The primary sync workflow lives in the Runtime tab, not the Settings page, because that is where all deployed artifacts are visible.

1. Open the Runtime tab

Navigate to Runtime and click ↻ Refresh if the list is empty. All currently deployed iFlows appear in the table.

2. Click LeanIX Match

When LeanIX is configured, a 🔷 LeanIX Match button appears in the toolbar. Click it to cross-reference every artifact in the table against your LeanIX workspace. A LeanIX column appears in the table showing one of:

3. Create or update fact sheets

• Per-row: Click Create (for unlinked iFlows) or Update (to push latest metadata) on any row.
• Bulk: Use Create All New or Sync All from the bulk action bar to process multiple iFlows at once.

After a successful sync the row status changes to ✓ Linked and a link to the fact sheet is shown.

How Authentication Works

CPI Studio authenticates with LeanIX using OAuth 2.0 client_credentials flow:

1. Your API token is exchanged for a bearer token at https://<host>/services/mtm/v1/oauth2/token
2. The bearer token is cached for its validity period (usually 1 hour) and refreshed automatically
3. All GraphQL and REST calls to /services/pathfinder/ use this bearer token

Your API token is never sent to third-party services — all calls go directly from the CPI Studio server to your LeanIX workspace.

Troubleshooting

Connection test fails

• Confirm the host does not include https:// or a trailing slash
• Verify the API token has not expired in LeanIX Settings → Technical Users
• Ensure the token has fact sheet read and write permissions

Category dropdown is empty

If the category combo-box shows no suggestions, your LeanIX API token may not have read access to all fact sheets in the workspace, or the workspace uses a free-text category field with no predefined values. Simply type the category value manually — it will be accepted.

Fact sheet created but fields are blank

Check your field mappings in Settings. If no mappings are configured, only the /description field is written. Add at minimum a name → /name mapping so the fact sheet gets a proper display name.

Sync says "Linked" but I can't see the fact sheet in LeanIX

The fact sheet may be restricted by ACL (access control) in LeanIX. Ask your LeanIX workspace admin to grant the service account read access, or check if the fact sheet is archived.

Changes not persisting after restart on Cloud Foundry

By default the CF container's filesystem is ephemeral. Use Settings → Export and set the APP_SETTINGS environment variable in your manifest.yml to persist configuration across restarts. See Configuration for details.