Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    List Of Incident Methods

    Note: Parameters wrapped in [ ] are optional.

    Table 1: Incident Methods

    Name and Description

    Parameters

    isIncidentType Check the incident type by either its code or its name.

    incident:string

    isIncidentDate Check to see if an incident occurred on the given month, day and year. The month, day and year arguments may be left empty to match any value.Note that Jan = 1, and years are in the format YYYY.

    [month:int]

    [day:int]

    [year:int]

    isIncidentDateRange Check to see if an incident occurred between two dates. All values must be defined. Note that Jan = 1, and years are in the format YYYY.

    start_month:int

    start_day:int

    start_year:int

    end_month:int

    end_day:int

    end_year:int

    isIncidentTime Check to see if an incident occurred at a given time. The hour, minute and second arguments may be left empty to match any value.

    [hour:int]

    [minute:int]

    [second:int]

    isIncidentTimeRange Check to see if an incident occurred between a given time range. All values must be specified.

    start_hour:int

    start_minute:int

    start_second:int

    end_hour:int

    end_minute:int

    end_second:int

    isIncidentCount Check the number of times an incident has occurred against an integer operation and specified value. Supported operations include (>, <, ==, !=). The results are: (count [operator] value)

    operator:string

    value:int

    isIncidentCountRange Check to see if the number of times an incident has occurred is within a given range.

    min:int

    max:int

    isIncidentContextSubString Check to see if the context XML associated with the incident contains the provided substring. The search is case sensitive by default, unless the second parameter is "false".

    search:string

    [[caseSensitive]:Boolean]

    isIncidentContextPattern Check to see if the context XML associated with an incident contains a simple pattern. Supported pattern wild cards include +, ? and *. Pattern matches are performed case sensitive unless the second parameter to this method is "false".

    pattern:string

    [[caseSensitive]:Boolean]

    isIncidentIP Check to see if an incident came from a given IP address. Each parameter specifies the required value for the specific block of the address. Any of the parameters can be left empty to match any value.

    [a_block:int]

    [b_block:int]

    [c_block:int]

    [d_block:int]

    isIncidentIPRange Check to see if an incident came from a given IP address range. Each parameter specifies a range of accepted values for the specific address block. Ranges are specified in the format: min-max. For example: 10-22, or 0-255

    [a_block_range:string]

    [b_block_range:string]

    [c_block_range:string]

    [d_block_range:string]

    isIncidentBrowser Check to see if the incident occurred from a given browser. The parameter expects the canonical name of the browser.

    name:string

    isIncidentOperatingSystem Check to see if the incident occurred from a given operation system. The parameter expects the canonical name of the operating system.

    name:string

    isInicdentBrowserVersion Check to see if the incident occurred from a specified version of the browser. The check is case sensitive by default, unless the second parameter is "false". The version could contain any character and should be considered as an arbitrary user supplied string value.

    version:string

    [[caseSensitive]:Boolean]

    isIncidentBrowserVersionPattern Check to see if the incident occurred from a browser with a version that matches a given simple pattern. Pattern wild cards >include ?, * and +. The match is done case sensitive unless the second parameter is "false". The version could contain any character and should be considered as an arbitrary user supplied string value.

    pattern:string

    [[caseSensitive]:Boolean]

    isIncidentBrowserVersionSubString Check to see if the incident occurred from a browser with a version that contains the given sub string. The match is done case sensitive unless the second parameter is "false". The version could contain any character and should be considered as an arbitrary user supplied string value.

    Search:string

    [[caseSensitive]:Boolean]

    isIncidentCountry Check to see if the incident originated from a given country. The parameter expects a valid 2 character country code, or the canonical name of the country.

    country:string

    isIncidentLatitude Check to see if the incident originated from a specified geographical latitude. The parameter is expected to be a decimal number between -90.0 and +90.0.

    latitude:float

    isIncidentLatitudeRange Check to see if the incident originated between a specified geographical latitude range.The parameters are expected to be decimal numbers between -90.0 and +90.0.

    min:float

    max:float

    isIncidentLongitude Check to see if the incident originated from a specified geographical longitude. The parameter is expected to be a decimal number between -90.0 and +90.0.

    longitude:float

    isIncidentLongitudeRange Check to see if the incident originated between a specified geographical longitude. The parameters are expected to be decimal numbers between -90.0 and +90.0.

    min:float

    max:float

    isIncidentCity Check to see if the incident originated in a specified city. The parameter is expected to be the city name and is case sensitive unless the second parameter is "false".

    city:string

    [caseSensitive]:Boolean

    isIncidentCityPattern Check to see if the incident originated from a city that matches a specified pattern. The supported wild cards are *>, ?, and +. The pattern is case sensitive unless the second parameter is "false".

    pattern:string

    [caseSensitive]:Boolean

    isIncidentCitySubString Check to see if the incident originated from a city that contains a specified sub string. The substring search is done case sensitive unless the second parameter is "false".

    search:string

    [caseSensitive]:Boolean

    isIncidentHost Check to see if the incident originated in a specified host. The parameter is expected to be the host name and is case sensitive unless the second parameter is "false".

    host:string

    [caseSensitive]:Boolean

    isIncidentHostPattern Check to see if the incident originated from a host name that matches a specified pattern. The supported wild cards are *, ?, and +. The pattern is case sensitive unless the second parameter is "false".

    pattern:string

    [caseSensitive]:Boolean

    isIncidentHostSubString Check to see if the incident originated from a host name that contains a specified sub string. The substring search is done case sensitive unless the second parameter is "false".

    search:string

    [caseSensitive]:Boolean

    isIncidentRegion Check to see if the incident originated in a specified region. The parameter is expected to be the region name and is case sensitive unless the second parameter is "false".

    region:string

    [caseSensitive]:Boolean

    isIncidentRegionPattern Check to see if the incident originated from a region that matches a specified pattern. The supported wild cards are *, ?, and +. The pattern is case sensitive unless the second parameter is "false".

    pattern:string

    [caseSensitive]:Boolean

    isIncidentRegionSubString Check to see if the incident originated from a region that contains a specified sub string. The substring search is done case sensitive unless the second parameter is "false".

    search:string

    [caseSensitive]:Boolean

    isIncidentZip Check to see if the incident originated in a specified zip code. The parameter is expected to be the zip code and is case sensitive unless the second parameter is "false". While zip codes should generally be numeric, there is the possibility of foreign zip codes containing strange characters.

    zip:string

    [caseSensitive]:Boolean

    isIncidentZipPattern Check to see if the incident originated from a zip code that matches a specified pattern. The supported wild cards are *>, ?, and +. The pattern is case sensitive unless the second parameter is "false".

    pattern:string

    [caseSensitive]:Boolean

    isIncidentZipSubString Check to see if the incident originated from a zip code that contains a specified sub string. The substring search is done case sensitive unless the second parameter is "false".

    search:string

    [caseSensitive]:Boolean

    Published: 2013-11-20