> ## 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.

# NCMMS

> Connect NCMMS to KODE OS for work orders data

> Connect NCMMS to KODE OS for work orders data integration

## Overview

Use this integration to connect NCMMS to KODE OS. You can collect work order data over REST with hybrid snapshot collection, ingest historical and multi-entity histories where configured, and use supported connector actions from Data Sources.

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

## Supported Capabilities

* Collect Sensor Data
* Collect Historical Data
* Collect Historical Multi-Entity Data

## Prerequisites

* An active account with NCMMS and access to their API or developer portal
* API key or token from the NCMMS platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the NCMMS 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 **NCMMS**
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       |
| **Organization ID**   | Yes      | text     | The organization ID in the vendor's API                 |
| **Site ID**           | Yes      | text     | The site identifier in the external system              |
| **GSA Address Code**  | Yes      | text     |                                                         |
| **API Key**           | Yes      | password | The API key for authenticating with the external system |
| **Collect Days Back** | Yes      | number   |                                                         |

## What Data You Get

### GSA Work Orders

Government Services Administration work order records

### Polling Schedule

* **GsaWorkOrder** -- Default polling: 10 minutes (min: 10 minutes, max: 1 hours)

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 NCMMS 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 NCMMS platform.
  </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 NCMMS API.
  </Accordion>
</AccordionGroup>