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

# UI Flow Sessions

> Monitor and manage active UI Flow sessions, track session activity, and view audit logs. UI Flow Sessions provides visibility into user interactions with UI Flows, including session status, audit trails, and associated processes.

## Overview

**UI Flow Sessions** provides a comprehensive interface for monitoring and managing active user sessions with UI Flows. This feature enables you to track session activity, view audit logs, monitor associated processes, and debug UI Flow interactions in real-time.

<Card title="UI Flows" icon="file-pen">
  UI Flows are reusable, multi-platform user interfaces that work across web, iOS, and Android. They provide an alternative to BPMN processes when full process orchestration is not required.
</Card>

<Frame>
  ![UI Flow Sessions Interface](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/5.x/uifs.png)
</Frame>

## Accessing UI flow sessions

Navigate to **Runtime Settings** → **UI Flow Sessions** from your project's Runtime view to access the sessions management interface.

<Info>
  You must have appropriate runtime permissions to view UI Flow Sessions. See [Workspace runtime editor](/5.9/setup-guides/access-management/workspaces-access-rights#workspace-runtime-editor) for details.
</Info>

## Sessions list

The **UI Flow Sessions** interface displays all active and historical sessions for UI Flows in your project. Each session appears as a row in the table with the following information:

| Column         | Description                                                           |
| -------------- | --------------------------------------------------------------------- |
| **ID**         | Unique session identifier (UUID format)                               |
| **UI Flow**    | The name of the UI Flow definition associated with this session       |
| **Status**     | Current session status (for example, `STARTED`, `FINISHED`, `ACTIVE`) |
| **Start Date** | Date and time when the session was initiated (localized format)       |

### Filtering and searching

Use the filter and search controls preceding the sessions table to find specific sessions:

* **Filter by definition**: Select a specific UI Flow definition from the dropdown to show only sessions for that UI Flow
* **Search by session id**: Enter a session ID (full or partial) to quickly locate a specific session

## Session details

Click on any session in the list to view detailed information about that session. The session details view provides comprehensive insights into session activity.

### Session information header

The session details header displays:

* **UI Flow**: The name of the UI Flow definition
* **UI Flow session ID**: The unique session identifier with a copy button for easy sharing
* **Status badge**: Visual indicator of the current session status (for example, `STARTED`, `FINISHED`)

### Detail tabs

The session details view includes four tabs for different aspects of the session:

<Tabs>
  <Tab title="Variables">
    Inspect runtime variables associated with the UI Flow session.

    The **Variables** tab displays the current state of all variables in the session. You can switch between two view modes using the dropdown:

    * **Tree View** — Expandable JSON tree viewer for navigating nested data structures
    * **JSON View** — Read-only Monaco code editor with JSON syntax highlighting

    Click **Export JSON** to download the session variables as a `.json` file.

    <Info>
      The Variables tab is the first tab in the session details panel, giving you immediate access to the session's data state when debugging.
    </Info>
  </Tab>

  <Tab title="Audit Log">
    View a chronological log of all events and actions that occurred during the session.

    **Audit Log columns:**

    | Column                 | Description                                                               |
    | ---------------------- | ------------------------------------------------------------------------- |
    | **Timestamp**          | Date and time when the event occurred (localized format)                  |
    | **User**               | User email or identifier who performed the action                         |
    | **Subject**            | Type of subject (e.g., "UI Flow Session")                                 |
    | **Event**              | Event type (e.g., "Start", "Navigate", "Action")                          |
    | **Subject Identifier** | Unique identifier for the subject (session ID, process instance ID, etc.) |
    | **Status**             | Event status (e.g., `success`, `failed`, `pending`)                       |
    | **View**               | Eye icon to view additional details about the event                       |

    <Frame>
      ![UI Flow Session Audit Log](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/5.x/uifs_audit_log.png)
    </Frame>

    **Common audit log events:**

    * **Start**: Session initialization
    * **Navigate**: Navigation between Navigation Areas
    * **Action**: Actions executed (e.g., Start Process, Navigate To)
    * **Process Start**: Process instances launched from the UI Flow
    * **Process Complete**: Process instances completed
  </Tab>

  <Tab title="Processes">
    View all process instances that were started from this UI Flow session.

    This tab shows:

    * Process instance IDs
    * Process definition names
    * Process status
    * Start and completion times
    * Links to process instance details

    <Info>
      Processes started from UI Flows using the **Start Process action** appear in this tab. This enables you to trace which business processes were triggered by user interactions in the UI Flow.
    </Info>
  </Tab>

  <Tab title="Workflows">
    View workflow execution details for workflows associated with this UI Flow session.

    This tab provides:

    * Workflow run IDs
    * Workflow execution status
    * Node-by-node execution timing
    * Input/output data
    * Execution logs

    <Card title="Workflow Debugging" icon="bug">
      Use the Workflows tab to debug workflow execution, view node execution times, and inspect data transformations. This is especially useful for troubleshooting AI agent workflows or data source operations.
    </Card>
  </Tab>
</Tabs>

## Session statuses

UI Flow sessions can have different statuses indicating their current state:

| Status       | Description                                                |
| ------------ | ---------------------------------------------------------- |
| **STARTED**  | Session has been initiated and is active                   |
| **ACTIVE**   | Session is currently active with ongoing user interactions |
| **FINISHED** | Session has been completed or closed                       |
| **FAILED**   | Session encountered an error and was terminated            |

<Info>
  Session statuses are updated in real-time as users interact with UI Flows. The status badge in the session details view reflects the current state.
</Info>

## Use cases

<CardGroup cols={2}>
  <Card title="Session monitoring" icon="eye">
    Monitor active UI Flow sessions to understand user engagement and identify sessions that may need attention or support.
  </Card>

  <Card title="Audit and compliance" icon="shield-check">
    Track all user interactions and actions within UI Flow sessions for audit purposes and compliance requirements.
  </Card>

  <Card title="Debugging and troubleshooting" icon="bug">
    Investigate issues by reviewing audit logs, process instances, and workflow executions associated with a specific session.
  </Card>

  <Card title="Performance analysis" icon="chart-line">
    Analyze session duration, process start times, and workflow execution performance to identify optimization opportunities.
  </Card>

  <Card title="User support" icon="headset">
    Use session details to help users by understanding what actions they performed and identifying where they may have encountered issues.
  </Card>

  <Card title="Process tracking" icon="diagram-project">
    Trace which business processes were triggered from UI Flow interactions and monitor their execution status.
  </Card>
</CardGroup>

## Best practices

<CardGroup cols={2}>
  <Card title="Regular monitoring" icon="clock">
    Regularly review active sessions to identify long-running sessions or sessions that may indicate user issues.
  </Card>

  <Card title="Use filters effectively" icon="filter">
    Use the filter by definition to focus on specific UI Flows when troubleshooting or analyzing usage patterns.
  </Card>

  <Card title="Review audit logs" icon="file-lines">
    Check audit logs for failed events or unexpected behavior patterns that may indicate configuration issues.
  </Card>

  <Card title="Track process launches" icon="play">
    Monitor the Processes tab to understand which business processes are most commonly triggered from UI Flows.
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Session not appearing in list">
    **Possible causes:**

    * Session hasn't been started yet
    * Filter is excluding the session
    * User doesn't have permission to view sessions

    **Solutions:**

    * Verify the UI Flow is being accessed by users
    * Clear filters and search again
    * Check user permissions for Runtime access
    * Verify the build containing the UI Flow is active
  </Accordion>

  <Accordion title="Audit log shows failed events">
    **Possible causes:**

    * Event handler configuration error
    * Process start failure
    * Workflow execution error
    * Permission issues

    **Solutions:**

    * Review the event details using the view icon
    * Check process definition is published and accessible
    * Verify workflow configuration in Integration Designer
    * Confirm user has necessary permissions
    * Review browser console for client-side errors
  </Accordion>

  <Accordion title="Process instances not showing">
    **Possible causes:**

    * Process wasn't started from the UI Flow
    * Process start action failed
    * Process instance was deleted

    **Solutions:**

    * Verify the Start Process action is configured correctly
    * Check audit log for process start events
    * Confirm process definition is in the active build
    * Review Failed Process Start section for errors
  </Accordion>
</AccordionGroup>

## Related resources

<CardGroup cols={2}>
  <Card title="UI Flows" href="/5.9/docs/building-blocks/ui-flows" icon="file-pen">
    Learn about UI Flows, their capabilities, and how to create and configure them.
  </Card>

  <Card title="Start Process action" href="/5.9/docs/building-blocks/ui-flows#configuring-the-start-process-action" icon="play">
    Understand how to configure Start Process actions to launch processes from UI Flows.
  </Card>

  <Card title="Process Instance" href="/5.9/docs/projects/runtime/active-process/process-instance" icon="diagram-project">
    Learn how to monitor and manage process instances that are started from UI Flows.
  </Card>

  <Card title="Chat Component" href="/5.9/ai-platform/chat-component" icon="comments">
    Understand how chat sessions are tracked within UI Flow Sessions for AI-powered workflows.
  </Card>
</CardGroup>