ARSperl Manual - GetEscalation Hash Values

## GetEscalation Hash Values

This structure is returned by ars_GetEscalation.

For ARS version 4.5:

    {
     "name"         => string,
     "changeDiary" => list of references to Diary Entry Structures,
     "helpText"     => string,
     "lastChanged"  => string,
     "timestamp"    => integer,
     "owner"        => string,
     "schemaList"   => list of 1 or more strings,
     "enable"       => integer,
     "query"        => ARQualifierStructPtr,
     "actionList"   => list of references to Active Link Action Structure,
     "elseList"     => list of references to Active Link Action Structure,
     "TmType"       => integer,
     "TmInterval"     => integer, *
     "TmMonthDayMask" => integer, *
     "TmWeekDayMask"  => integer, *
     "TmHourMask"     => integer, *
     "TmMinute"       => integer, *
     "objPropList"     => list of references to Property Hash
    }

For ARS version 2.x, 3.x and 4.0.x:

    {
     "name"         => string,
     "changeDiary" => list of references to Diary Entry Structures,
     "helpText"     => string,
     "lastChanged"  => string,
     "timestamp"    => integer,
     "owner"        => string,
     "schema"       => string,
     "enable"       => integer,
     "query"        => ARQualifierStructPtr,
     "actionList"   => list of references to Active Link Action Structure,
     "elseList"     => list of references to Active Link Action Structure, (>=3.x)
     "TmType"       => integer,
     "TmInterval"     => integer, *
     "TmMonthDayMask" => integer, *
     "TmWeekDayMask"  => integer, *
     "TmHourMask"     => integer, *
     "TmMinute"       => integer, *
    }

* If `TmType == AR_ESCALATION_TYPE_INTERVAL` then `TmInterval` will be defined and the other `Tm*` keys will not be defined. `TmInterval` will specify how many seconds should elapse between firings of the Escalation.

* If `TmType == AR_ESCALATION_TYPE_TIMEMARK` then `TmInterval` will not be defined and the other `Tm*` keys will be defined. In this case, use the `ARS::AR_DAY()` and `ARS::AR_HOUR()` helper functions to analyze the information held in these hash values. These variables, in concert, specify when the Escalation should fire.

Table of Contents