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

# Avigilon Alta

> Connect Avigilon Alta to KODE OS for access control data

> Connect Avigilon Alta to KODE OS for access control data integration

## Overview

Use this integration to connect your Avigilon Alta (formerly Openpath) access control system to KODE OS. You can discover ACUs, readers, locks, and related devices, then monitor status, alarms, and operational data from the platform.

| Property            | Value          |
| ------------------- | -------------- |
| **System Type**     | Access Control |
| **Communication**   | REST           |
| **Collection**      | Pull           |
| **Collection Mode** | SNAPSHOT       |

## Supported Capabilities

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

## Prerequisites

* An active account with Avigilon Alta and access to their API or developer portal
* Username and password credentials for the Avigilon Alta system
* KODE OS environment with access to Data Sources

## Configure Connector in KODE OS

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

| Field               | Required | Type     | Description                                              |
| ------------------- | -------- | -------- | -------------------------------------------------------- |
| **URL**             | No       | text     | The base URL or IP address of the external system        |
| **Username**        | No       | text     | The username for authenticating with the external system |
| **Password**        | No       | password | The password for authenticating with the external system |
| **Organization ID** | No       | password |                                                          |
| **API Building ID** | No       | password | The building or source 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 Avigilon Alta 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).

## Devices and Points

When you discover devices from Avigilon Alta, KODE OS maps them to the following device types and data points:

### Access Controller

Canonical Type: `default`

| #  | Point                    | Description                                                                          | Unit | Writable | Collection |
| -- | ------------------------ | ------------------------------------------------------------------------------------ | ---- | -------- | ---------- |
| 1  | `connectionStatus`       | **True** -- device is connected / **False** -- device is disconnected                | --   | No       | Polling    |
| 2  | `temperature`            | Current temperature reading (°C)                                                     | °C   | No       | Polling    |
| 3  | `is_virtual`             | **True** -- is\_virtual is active / **False** -- is\_virtual is not active           | --   | No       | Polling    |
| 4  | `Status`                 | Current operating status                                                             | --   | No       | Polling    |
| 5  | `entry_count`            | Cumulative count of events                                                           | --   | No       | Polling    |
| 6  | `offline_entry_count`    | Cumulative count of events                                                           | --   | No       | Polling    |
| 7  | `user_count`             | Number of unique users                                                               | --   | No       | Polling    |
| 8  | `group_count`            | Number of groups                                                                     | --   | No       | Polling    |
| 9  | `Locked`                 | **True** -- access point is locked / **False** -- access point is unlocked           | --   | No       | Polling    |
| 10 | `fdr_active`             | **True** -- fire door release is active / **False** -- fire door release is inactive | --   | No       | Polling    |
| 11 | `current_lock_state`     | Current state of the lock mechanism                                                  | --   | No       | Polling    |
| 12 | `primary_battery_status` | Primary battery condition                                                            | --   | No       | Polling    |
| 13 | `rtcc_status`            | Real-time clock controller status                                                    | --   | No       | Polling    |
| 14 | `comm_status`            | Communication link status                                                            | --   | No       | Polling    |
| 15 | `battery_level`          | Device battery level                                                                 | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including connectionStatus, temperature, is\_virtual, Status, entry\_count, offline\_entry\_count, user\_count, group\_count, and 7 more, collected at regular intervals from connected devices

### Alarms

Alert and fault notifications including alarm name, priority, status, timestamps, device association, and acknowledgment state

KODE OS maps Avigilon Alta data to these standard fields:

| KODE Field       | Source Field          | Notes                |
| ---------------- | --------------------- | -------------------- |
| **id**           | `idExt`               | --                   |
| **name**         | `eventName`           | --                   |
| **description**  | `note`                | --                   |
| **priority**     | `alarmSeverity.name`  | --                   |
| **status**       | `alarmStatus.name`    | --                   |
| **deviceId**     | `entryId`             | --                   |
| **deviceName**   | `entryName`           | --                   |
| **updatedBy**    | `userName`            | --                   |
| **createdAt**    | `createdAt`           | --                   |
| **startedAt**    | `firstAcknowledgedAt` | --                   |
| **completedAt**  | `lastAcknowledgedAt`  | --                   |
| **updatedAt**    | `updatedAt`           | --                   |
| **customFields** | `(custom fields)`     | custom fields object |

### Audit Logs

Access and security event records including badge swipes, door access events, person identification, timestamps, and access results

KODE OS maps the collected data to these standard fields:

| KODE Field          | Description                                     |
| ------------------- | ----------------------------------------------- |
| **ID**              | Unique log entry identifier                     |
| **Description**     | Event description                               |
| **Person Name**     | Name of the person involved                     |
| **Credential ID**   | Badge or credential identifier used             |
| **Credential Type** | Type of credential (e.g., Card, PIN, Biometric) |
| **Role**            | Access role or clearance level                  |
| **Type**            | Event type (e.g., Entry, Exit, Denied)          |
| **Result**          | Access result (Granted, Denied, Error)          |
| **Access Point**    | Door or access point name                       |
| **Location**        | Physical location of the access point           |
| **Access Time**     | Timestamp of the access event                   |
| **Created At**      | Timestamp when the log was recorded             |

### Polling Schedule

* **Point History** -- Default polling: 1 minutes (min: 1 minutes, max: 1 hours)
* **Alarm** -- Default polling: 1 hours (min: 1 hours, max: 1 days)
* **Audit Log** -- Default polling: 1 hours (min: 1 hours, max: 1 days)

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

## Use Cases

Once connected, this integration enables you to:

* Centralize access event monitoring across all entry points and zones
* Generate audit trails for security compliance and investigation
* Correlate access patterns with occupancy and energy data for building optimization

## 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. Verify the username and password are correct and the account has not been locked in the Avigilon Alta system.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Avigilon Alta 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 Avigilon Alta API.
  </Accordion>
</AccordionGroup>
