API Programming Guide › CA User Activity Reporting Module API Examples › Query and Report Viewer Calls › Query Specifications › Time Zone Specifications

Time Zone Specifications

You can add a time zone specification to your getQuery or runQuery call. You can retrieve a list of available time zones using getTimeZones.

Time Zone Specification Example

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_By_Event_Action&timezone=TIMEZONENAME

In this case, "&timezone=" specifies the name of the time zone you want. Your time zone name replaces "TIMEZONENAME", as displayed in the list returned by the getTimeZones call.

Note: The response to an invalid time zone differs depending on the call you include it in:

• If an invalid time zone is used in the runQuery call, GMT timestamps are returned. If no time zone is passed then the default is the time zone where the server is running.
• If no time zone, or an invalid time zone is used in the getQueryViewer or getReportViewer call then the default is the target server time zone.

More information:

getTimeZones

runQuery

More information:

IncidentFilter XML Specifications

Filter XML Specifications

You can preset CA User Activity Reporting Module filters for your report in XML format and add them to the getQueryViewer, getReportViewer, getIncidentViewer, or runQuery URL using the filterXML term. You can nest multiple filters, using AND and OR terms and parentheses. You are essentially creating CA User Activity Reporting Module 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:

lparens

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.

rparens

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.