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

# Data Intelligence Layer

> How the Data Intelligence Layer, built on the Data-Index subsystem, maintains a continuously updated snapshot of process state for real-time visibility into running processes.

The Data Intelligence Layer, implemented through the Data-Index subsystem, provides a continuously updated snapshot of process state that enables real-time visibility into your business processes. This component is a key element of the Adaptive Process Architecture, offering powerful querying capabilities to analyze and monitor your process instances.

## Overview

The Data-Index subsystem maintains a real-time view of process instances by efficiently processing events from the process engine and storing them in an optimized format for querying. This provides a comprehensive view of active processes without impacting the performance of the process execution engine.

[<img src="https://mintcdn.com/aletyx-3353d50c/UdT8DI1QFCgugDzY/images/architecture/core/processes/architecture/images/data-index.png?fit=max&auto=format&n=UdT8DI1QFCgugDzY&q=85&s=8cbc6fbf27ba2bf85e6f3e3ad27fb317" alt="Graphical view of the Data-Index subsystem" width="525" height="552" data-path="images/architecture/core/processes/architecture/images/data-index.png" />](/docs/images/architecture/core/processes/architecture/images/data-index.png)

The system consists of three main components:

* **Transport**: The medium used to transfer events between the runtime and the Data-Index service. In the Adaptive Process Architecture, this is in-vm transport.
* **Storage**: The persistence tier of the Data-Index component, typically using the same database as the rest of the application.
* **Data-Index**: The main component responsible for creating/updating the Data-Index, and for providing query capabilities.

## Key Features

### Real-Time Process Visibility

The Data-Index receives incremental state change events from the Orchestration Engine and efficiently computes the current state by integrating these changes with existing contextual data. This provides an up-to-date view of all process instances without the need for complex synchronization mechanisms.

### GraphQL Querying Capabilities

The Data-Index exposes powerful GraphQL interfaces that allow both systems and users to query process data using flexible, domain-specific queries. This enables:

* Advanced filtering and sorting
* Relationship traversal across process instances
* Selection of specific process attributes
* Complex conditional queries

### Dashboarding Support

The Data-Index serves as the foundation for process monitoring dashboards, providing the necessary data access layer to:

* Track KPIs and business metrics
* Monitor process throughput
* Identify bottlenecks
* Visualize process flows

### Low-Impact Monitoring

By maintaining a separate query-optimized data store, the Data-Index allows comprehensive monitoring and analysis without impacting the performance of the process execution engine.

## Using GraphQL with Data-Index

The Data-Index supports GraphQL queries through the following endpoint:

```text theme={null}
http://localhost:8080/<root-path>/graphql-ui/
```

This provides an interactive GraphQL interface for exploring and querying your process data.

### Example Queries

#### Retrieve All Process Instances

```graphql theme={null}
{
  ProcessInstances {
    id
    processId
    state
    start
    end
    parentProcessInstanceId
    rootProcessInstanceId
    roles
  }
}
```

#### Find Process Instances by State

```graphql theme={null}
{
  ProcessInstances(where: {state: {equal: "ACTIVE"}}) {
    id
    processId
    state
    start
    businessKey
  }
}
```

#### Retrieve Process Variables

```graphql theme={null}
{
  ProcessInstances(where: {processId: {equal: "claim_initiation"}}) {
    id
    processId
    state
    variables
  }
}
```

## Adding Data-Index to Your Project

The Data-Index capability can be added to your project by including the following dependency:

```xml theme={null}
<dependency>
  <groupId>org.kie</groupId>
  <artifactId>kogito-addons-quarkus-data-index-jpa</artifactId>
</dependency>
```

This dependency enables Quarkus to use the in-vm transport tier and specifies the storage mechanism for the Data-Index simultaneously.

## Configuration

The Data-Index automatically uses the same data source as your main application, which simplifies configuration and deployment. The most important configuration properties for the Data-Index are:

```properties theme={null}
# Enable or disable the Data-Index
kogito.data-index.enabled=true

# Configure GraphQL path (optional, defaults to /graphql)
kogito.data-index.graphql.ui.path=/graphql-ui
```

## Best Practices

### Optimizing Queries

* Limit result sets using pagination for large data volumes
* Select only the fields you need to reduce response size
* Use appropriate indexing on the database for frequently queried fields
* Consider caching for repeated identical queries

### Integration with Monitoring Tools

* Use the GraphQL API to feed data to your monitoring dashboards
* Setup alerts based on process KPIs
* Implement automatic reporting for key business metrics

### Performance Considerations

* The Data-Index adds some overhead to process execution due to event processing
* For extremely high-throughput scenarios, consider making the Data-Index optional
* Monitor the size of your Data-Index database and implement appropriate retention policies

## See Also

* [Process History Service](/docs/architecture/processes/architecture/process-history)
* [Process Data & Persistence](https://docs.aletyx.ai/core/processes/architecture/data-index/data.md)
* [GraphQL API Reference](https://docs.aletyx.ai/core/processes/apis/graphql-api.md)