---
title: QuickSQL
url: 'https://www.twelvetone.tv/docs/business-management/sis/quick-sql'
markdown: 'https://www.twelvetone.tv/docs/business-management/sis/quick-sql.md'
date: '2026-09-25'
description: 'Custom filters can be created that interact directly with the database, other sources. The filters can apply custom application logic. Creati'
taxonomy:
  category:
    - docs
  devtype:
    - beta
---

[](#)  [ Home ](https://www.twelvetone.tv/docs/)     [ Business Management ](https://www.twelvetone.tv/docs/business-management)     [ Student Information Services (SIS) ](https://www.twelvetone.tv/docs/business-management/sis)      QuickSQL    

This product is in *beta state*. 
It is available to registered beta testers only.

Custom filters can be created that interact directly with the database, other sources. The filters can apply custom application logic.

# Creating QuickSQL filters

## Using The Filesytem

Add one or more files in the configuration/sql folder with suffix .sql.xml or .sql.

## Using OSGi Services

Register a *SqlStatementProvider* that returns *SqlStatement* items.

## Additional Support

The sytem supplies abstract classes for registering additional file and resource based .sql.xml files.

# Format

## SQL Format

- The SQL statement must return a recordset with the relevant id as the first field.
- SQL statements must contain a WHERE clause.
- Fields must use native SQL fields, not JPA field names. ```sql
    select id from customers where lastName like '%manchu%';
    ```

    ## .sql Format

    The filename is used as the query name, and the contents are used a the SQL query.

## sql.xml Format

The sql.xml file format allows specifying multiple filters in one file. A caption and description can be associated with each filter. See *sql format* for query rules

```xml
<sql-items>
    <sql-item>
        <caption>The Manchus</caption>
        <description>All customers with Manchu in their last name.</description>
        <sql>select id from customers where lastName like '%manchu%';</sql>
    </sql-item>
</sql-items>
```

# Using QuickSQL filters

The recipients activity has a QuickSQL menu item. Selecting it will display a list of registered queries.

![](https://www.twelvetone.tv/docs/user/pages/04.business-management/02.sis/02.quick-sql/Screen%20Shot%202018-04-10%20at%207.44.06%20AM.png)

The QuickSQL is not a savable filter. Reapplying filters will remove any items added by QuickSQL.

 [ ](https://www.twelvetone.tv/docs/business-management/sis/sandbox) [](https://www.twelvetone.tv/docs/business-management/pledge-to-provide)

---

## Navigation

- Parent: [Student Information Services (SIS)](https://www.twelvetone.tv/docs/business-management/sis.md)
- Previous: [Sandbox](https://www.twelvetone.tv/docs/business-management/sis/sandbox.md)