Cisco Cisco Prime Home 6.3 Developer's Guide

 

OL-28558-01   v5.1

 

17 

For instance: 

 

•  Search for any documents with any field containing the term "john"  

•  Search for any documents with a "name" field containing the term "john"  

•  Search for "subscriber" documents with a "name" field containing the 

term "john" 

Case Sensitivity  

Keywords and field names are case sensitive. For instance, the "subscriber" 

document is all lowercase. The downstream attenuation field of the "device" 

document must be exactly "downstreamAttenuation".  

 

Values are case insensitive. For instance, searching for the name "Jane", all the 

following are equivalent: "Jane", "JANE", "jane".  

Terms  

In its simplest form, a CAQL query can consist of a single term. This query 

searches for any documents that contain "juniper" in any field:  

 

juniper  

 

Often a search term should be restricted so that it only matches a certain field. 

The following query demonstrates searching for any documents with field 

"name" that contains "juniper":  

name: juniper 

 

Many fields are aliased so that they can be referred to using alternate names. 

For instance, the "subscriber" document has a "subscriberCode" field which may 

be referenced as "code". These aliases are provided for convenience and 

readability of CAQL. A complete list of fields and aliases is outside the scope of 

this document.  

 

Specifying Document Type  

By default, search terms are matched against all document types. Document 

types include "subscriber", "device", "user", etc. The search can be restricted to 

match only a specified document type using the "with" clause, which precedes 

the search terms. The following query searches for subscribers with any field 

containing "juniper".  

 
subscribers with juniper