> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IBM Maximo (CF)

> Connect IBM Maximo (CF) to KODE OS for work orders, asset data

> Connect IBM Maximo (CF) to KODE OS for work orders, asset data integration

## Overview

Use this integration to connect IBM Maximo to KODE OS for work orders and asset data. You can discover devices and points, collect operational data with hybrid historical collection over REST, and use supported actions for maintenance and asset workflows.

| Property            | Value                |
| ------------------- | -------------------- |
| **System Type**     | Work Orders, Asset   |
| **Communication**   | REST                 |
| **Collection**      | Hybrid (Pull + Push) |
| **Collection Mode** | HISTORICAL           |
| **Actions**         | Supported            |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data
* Discover Assets

## Prerequisites

* An active account with IBM Maximo (CF) and access to their API or developer portal
* API key or token from the IBM Maximo (CF) platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the IBM Maximo (CF) platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it when configuring the connector in KODE OS

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **IBM Maximo (CF)**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field           | Required | Type     | Description                                             |
| --------------- | -------- | -------- | ------------------------------------------------------- |
| **URL**         | Yes      | text     | The base URL or IP address of the external system       |
| **API Key**     | Yes      | password | The API key for authenticating with the external system |
| **Site ID**     | Yes      | text     | The site identifier in the external system              |
| **Location ID** | Yes      | text     | The location identifier in the external system          |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the IBM Maximo (CF) system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## What Data You Get

### Work Orders

Maintenance and service requests including title, description, status, priority, assignee, due dates, vendor response, resolution details, and cost estimates

KODE OS maps IBM Maximo (CF) data to these standard fields:

| KODE Field        | Source Field            | Notes                |
| ----------------- | ----------------------- | -------------------- |
| **id**            | `workOrderId`           | --                   |
| **woNumber**      | `woNum`                 | --                   |
| **description**   | `description`           | --                   |
| **status**        | `statusDescription`     | --                   |
| **priority**      | `woPriorityDescription` | --                   |
| **category**      | `woClassify`            | --                   |
| **floor**         | `floor`                 | --                   |
| **createdBy**     | `reportedBy`            | --                   |
| **assignedTo**    | `owner`                 | --                   |
| **createdAt**     | `reportDate`            | transformed          |
| **updatedAt**     | `changeDate`            | transformed          |
| **dueDate**       | `targCompDate`          | transformed          |
| **startedAt**     | `actStart`              | transformed          |
| **completedAt**   | `actFinish`             | transformed          |
| **estimatedCost** | `actLabCost`            | --                   |
| **assetId**       | `assetNum`              | --                   |
| **externalUrl**   | `href`                  | --                   |
| **customFields**  | `(custom fields)`       | custom fields object |

### Polling Schedule

* **WorkOrder** -- Default polling: 30 minutes (min: 30 minutes, max: 1 days)
* **Asset** -- Default polling: 1 days (min: 1 days, max: 1 days)

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Available Actions

This integration supports actions that allow you to send commands to the IBM Maximo (CF) system. Available actions are displayed on the device or entity detail page in KODE OS.

#### Example Request

```json theme={null}
{
  "action": "ActionName",
  "target": "entity-or-device-id",
  "parameters": {}
}
```

#### Expected Result

* KODE OS sends the action to the external API using the configured connector credentials
* The external system returns success (typically HTTP 2xx) and processes the requested operation

For more details on how actions work, see the [Actions guide](/products/integrations/capabilities/actions).

## Use Cases

Once connected, this integration enables you to:

* Centralize maintenance requests and work order status from facility management systems
* Create and update work orders directly from KODE OS when issues are detected
* Track maintenance KPIs including response time, completion rate, and cost

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Ensure the API key or token is valid and has not been revoked or expired in the IBM Maximo (CF) platform.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the IBM Maximo (CF) system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the IBM Maximo (CF) API.
  </Accordion>
</AccordionGroup>