Skip to main content

Query Builder

The OSPROV Query Builder is a powerful visual tool that allows users to create dynamic queries for extracting and analyzing workflow submission data. It provides an intuitive interface to filter, aggregate, and export data without requiring technical knowledge of database queries.

What is Query Builder?​

Query Builder is a feature that enables users to:

  1. Create Custom Queries: Build queries visually without writing SQL or code
  2. Generate API Endpoints: Automatically create secure REST APIs for data access
  3. Analyze Workflow Data: Extract insights from submission data across workflows
  4. Export Results: Download query results in various formats for reporting

Key Features​

Visual Query Building​

Build complex queries using an intuitive drag-and-drop interface. No coding or SQL knowledge required.

Advanced Filtering​

Apply sophisticated filters to narrow down your data:

  • Text matching (equals, contains, starts with, ends with)
  • Numeric comparisons (greater than, less than, between)
  • Date ranges and relative dates
  • Null value handling

Data Aggregation​

Perform calculations on your data:

  • Sum, average, minimum, maximum
  • Count and count distinct
  • Group by operations

Automatic API Generation​

Each saved query generates a secure REST API endpoint that can be consumed by external systems, dashboards, or reports.

Real-time Preview​

See your query results instantly before saving, ensuring accuracy and completeness.

Export Capabilities​

Export query results in multiple formats:

  • CSV for spreadsheets
  • Excel for advanced analysis
  • JSON for system integration

Use Cases​

Reporting and Analytics​

  • Generate custom reports for management
  • Track KPIs and metrics
  • Monitor workflow performance
  • Analyze submission trends

System Integration​

  • Feed data to external dashboards
  • Integrate with BI tools
  • Synchronize with other systems
  • Automate data extraction

Data Monitoring​

  • Track pending approvals
  • Monitor overdue tasks
  • Identify bottlenecks
  • Alert on specific conditions

Compliance and Auditing​

  • Extract audit trails
  • Generate compliance reports
  • Track user activities
  • Monitor data changes

How It Works​

  1. Select Workflow: Choose the workflow containing your data
  2. Choose Fields: Select which data fields to include
  3. Apply Filters: Add conditions to narrow results
  4. Add Aggregations: Include calculations if needed
  5. Preview Results: Verify your query output
  6. Save Query: Create your query and generate API
  7. Access via API: Use the endpoint in your applications

Prerequisites​

To use Query Builder effectively, you need:

  • Access to at least one published workflow with submission data
  • Appropriate permissions to create and execute queries
  • Basic understanding of your workflow data structure
  • API token for programmatic access (if using APIs)

Getting Started​

Ready to build your first query? Start with these resources:

  1. Getting Started Guide - Learn the basics
  2. Building Queries - Create your first query
  3. Using Query APIs - Access data programmatically
  4. Best Practices - Optimize your queries

Security and Permissions​

Query Builder respects all existing security settings:

  • User Permissions: Users can only query workflows they have access to
  • Data Security: Row-level and field-level security is enforced
  • API Authentication: All API access requires valid authentication tokens
  • Audit Logging: All query executions are logged for security auditing

Support​

Need help with Query Builder?

  • Check the Troubleshooting Guide for common issues
  • Review Best Practices for optimization tips
  • Contact your system administrator for permission issues
  • Refer to the technical documentation for API details