<HTML>
<HEAD>
<TITLE>ARSperl Manual - GetEscalation Hash Values</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>GetEscalation Hash Values</H2>
This structure is returned by
<A href="ars_GetEscalation.html">ars_GetEscalation</a>.
<p>
For ARS version 4.5:
<PRE>
{
"name" => string,
"changeDiary" => <i>list</I> of references to <a href="ds_diaryentry_hash.html">Diary Entry Structures</a>,
"helpText" => string,
"lastChanged" => string,
"timestamp" => integer,
"owner" => string,
<font color='red'>"schemaList" => <I>list</I> of 1 or more strings</font>,
"enable" => integer,
"query" => ARQualifierStructPtr,
"actionList" => <B>list</B> of references to <A HREF="ds_alas.html">Active Link Action Structure</A>,
"elseList" => <B>list</B> of references to <A HREF="ds_alas.html">Active Link Action Structure</A>,
"TmType" => integer,
"TmInterval" => integer, <B>*</B>
"TmMonthDayMask" => integer, <B>*</B>
"TmWeekDayMask" => integer, <B>*</B>
"TmHourMask" => integer, <B>*</B>
"TmMinute" => integer, <B>*</B>
<font color='red'>"objPropList" => <I>list</I> of references to <a
href="ds_prop_hash.html">Property Hash</a></font>
}
</PRE>
For ARS version 2.x, 3.x and 4.0.x:
<PRE>
{
"name" => string,
"changeDiary" => <i>list</I> of references to <a href="ds_diaryentry_hash.html">Diary Entry Structures</a>,
"helpText" => string,
"lastChanged" => string,
"timestamp" => integer,
"owner" => string,
"schema" => string,
"enable" => integer,
"query" => ARQualifierStructPtr,
"actionList" => <B>list</B> of references to <A HREF="ds_alas.html">Active Link Action Structure</A>,
"elseList" => <B>list</B> of references to <A HREF="ds_alas.html">Active Link Action Structure</A>, <B>(>=3.x)</B>
"TmType" => integer,
"TmInterval" => integer, <B>*</B>
"TmMonthDayMask" => integer, <B>*</B>
"TmWeekDayMask" => integer, <B>*</B>
"TmHourMask" => integer, <B>*</B>
"TmMinute" => integer, <B>*</B>
}
</PRE>
<B>*</B> If <CODE>TmType == AR_ESCALATION_TYPE_INTERVAL</CODE> then
<CODE>TmInterval</CODE> will be defined and the other <CODE>Tm*</CODE> keys
will <B>not</B> be defined. <CODE>TmInterval</CODE> will specify how many
seconds should elapse between firings of the Escalation. <P>
<B>*</B> If <CODE>TmType == AR_ESCALATION_TYPE_TIMEMARK</CODE> then
<CODE>TmInterval</CODE> will <B>not</B> be defined and the other
<CODE>Tm*</CODE> keys will be defined. In this case, use the
<CODE><A HREF="AR_DAY.html">ARS::AR_DAY()</A></CODE> and
<CODE><A HREF="AR_HOUR.html">ARS::AR_HOUR()</A></CODE>
helper functions to analyze the
information held in these hash values. These variables, in concert, specify
when the Escalation should fire.
<P>
<HR WIDTH="30%">
<P>
<A HREF="toc.html"><IMG ALT="<--" SRC="arrow.gif" ALIGN=CENTER> Table of Contents </A>
<p>
<address>
Last changes to this page 16 July 1998 by jcmurphy@arsperl.org<br>
© J.C.Murphy, J.W.Murphy 1997 arsperl@arsperl.org
</address>
</BODY>
</HTML>