Cisco Cisco Prime Home 6.3 Developer's Guide

 

OL-28558-01   v5.1

 

16 

Search and CAQL 

ClearAccess Query Language (CAQL) is a domain-specific language (DSL) for 

specifying search queries. Search queries are executed against the Prime Home 

ACS to list subscribers, devices, and other ACS data that match the query 

criteria.  

 

CAQL is used to support features throughout the product:  

•  Searching for devices, subscribers, and other data within the Portal web 

application  

•  Selecting devices for bulk operations  

•  Subscriber and device reports, including CSV export  

 

 

For subscriber and device reports the user does not have to enter CAQL 

directly. A user interface is provided that allows the user to create a report 

using drag-and-drop and by entering simple criteria.  

 

CAQL is a language for specifying queries against a search engine. In order to 

understand how to write CAQL, it is useful to understand the basics of how the 

search engine works.  

 

Data in the search engine is organized into documents. In Prime Home there are 

several document types, including "subscriber", "device", "user", and others. 

Each "subscriber" document in the search engine represents one subscriber in 

the Prime Home database. Each "device" document represents a device. Etc.  

 

Within each document there are fields. The "subscriber" document contains 

fields which defined the various properties for the subscriber, for example 

"name", and "address". The "device" document contains fields which define the 

various properties, characteristics, and data collected from the device, for 

example "serialNumber", "informCount", and "downstreamAttenuation".  

 

A complete list of available documents and fields is documented elsewhere. 

Within each field there are terms. A term is a simply a single word. For example, 

the subscriber John Doe has a "name" field containing the terms "john" and 

"doe". CAQL searches can be constructed to be as precise as desired.