Skip to main content

User Contexts

User Contexts are powerful, user-defined ledgers of data that function as customizable time series database tables. They provide a flexible way to store and manage various types of information related to your project.

Overview​

User Contexts allow you to:

  • Create custom data structures tailored to your specific needs
  • Store and retrieve time-based data efficiently
  • Integrate with other platform features, such as the Rule Engine

Creating a User Context​

When creating a User Context, you can define multiple fields to structure your data. For each field, you can specify:

  1. Name: A unique identifier for the field
  2. Field Type: Any standard PostgreSQL data type
  3. Required: Whether the field is mandatory or optional
  4. Partition By: Option to partition data based on this field
  5. Indexes: Add indexes to optimize query performance

Certainly! I'll add a new section for Integration with Dashboard Panels and include the information about default columns. Here's the updated markdown documentation:

Default Columns​

Every User Context automatically includes two default columns:

  • timestamp: Automatically filled with the date and time when a row is inserted.
  • source_id: Stores the origin of the row, such as an Action ID or other identifier.

These default columns provide built-in tracking for when and where data entries originate, enhancing traceability and analysis capabilities.

Use Cases​

User Contexts are versatile and can be used for various purposes, including:

  • Storing user transaction data
  • Tracking event logs
  • Managing time-series metrics

Example: Transaction Data Storage​

One common use case for User Contexts is storing transaction data. Here's how you might set it up:

  1. Create a User Context for transactions
  2. Define fields such as:
    • transaction_id (text, required)
    • amount (numeric, required)
    • currency (text, required)
    • timestamp (timestamp, required, partition by)
    • user_id (text, required)
    • status (text, required)
  3. Add indexes on frequently queried fields (e.g., user_id, status)

Integration with Rule Engine​

User Contexts can be seamlessly integrated with the platform's Rule Engine.

Example Workflow​

  1. Create a Rule that acts as a webhook for payment events
  2. Define an action within the Rule to store transaction info in the User Context
  3. Automatically populate your transaction User Context as payments are processed

This integration allows for real-time data capture and storage, enabling you to build powerful, data-driven features for your application.

Integration with Dashboard Panels​

User Contexts serve as powerful data sources for creating dynamic and insightful dashboard panels. This integration allows you to visualize and analyze your data effectively.

Using User Contexts in Dashboards​

  1. Data Source Selection: Choose a User Context as the data source for your dashboard panel.

  2. Parameter Configuration: Utilize the columns from your User Context as parameters for your visualizations.

  3. Data Manipulation: Apply various data operations to your User Context data:

    • Aggregations (e.g., sum, average, count)
    • Computational queries
    • Filtering and sorting

  4. Visualization Options: Present your data using a variety of chart types:

    • Line charts
    • Bar charts
    • Tables
    • Pie charts
    • And more

Example Workflow​

  1. Select your "Transactions" User Context as a data source.
  2. Use the "amount" column for values and "timestamp" for the x-axis.
  3. Apply a sum aggregation on "amount" grouped by day.
  4. Visualize the result as a line chart showing daily transaction totals.

This integration enables you to create rich, data-driven dashboards that provide real-time insights into your application's performance and user behavior.