API Programming Guide › CA Enterprise Log Manager API Examples › Query and Report Viewer Calls › Query Specifications › Filter XML Specifications

Filter XML Specifications

You can preset CA Enterprise Log Manager filters for your report in XML format and add them to the getQueryViewer, getReportViewer, or runQuery URL using the filterXML term. You can nest multiple filters, using AND and OR terms and parentheses. You are essentially creating CA Enterprise Log Manager advanced filters in XML.

Important! FilterXml terms are complex, and the API performs no validation. Invalid filter terms result in a query error. For this reason, we recommend that you take particular care in constructing your filter terms.

The available filter elements, listed in the order in which they must be used, are as follows:

• lpar

  Defines the number of left parentheses. The valid values are 0 or more.

• logic

  Sets the logical term connecting filters; AND or OR. For the first filter term, always leave the logic value empty.

• col

  Defines the event columns queried. You can get the list of available columns by using getDataModel.

• oper

  Defines an operator for the filter. The valid case-sensitive values are:

  • EQUAL - Equal to
  • NEQ - Not Equal to
  • LESS - Less than
  • GREATER - Greater than
  • LEQ - Less than or Equal to
  • GREATEQ - Greater than or Equal to
  • LIKE - Like
  • NOTLIKE - Not Like
  • INSET - In Set
  • NOTINSET - Not in Set
  • MATCH - Matches
  • KEYED - Keyed
  • NOTKEYED - Not Keyed
• val

  Defines the value for which the filter searches.

• rpar

  Defines the number of right parentheses. The valid values are 0 or more. The total number of right parenthesis always matches the number of left parenthesis.

When you view a graphical query or report, you can view or adjust the FilterXML terms you set from the advanced filter section of the Local Filter dialog in the viewer interface.

Filter XML Specification Example

This example shows a getQueryViewer call with a filter statement. The filter terms are shown expanded for clarity.

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_By_Event_Action&server=ELMSERVER&filterXml=
  <Filter logic="" lparens="1" col="source_username" oper="LIKE" val="su" rparens="0"/>
  <Filter logic="AND" lparens="0" col="event_logname" oper="LIKE" val="CALM" rparens="1"/>
</Scope>

"&filterxml=" specifies that a filter statement follows.

The filter statement sets the query to search the source_username column for "su", and the event_logname column for "CALM". Because an AND statement joins the two terms (Filter logic="AND"), only events where each value is found in its respective columns are returned.