<parameter> element

Defines a computable parameter that can be used in the search filter.

<reports> 
  <report>
    <filterParameters>
      <parameter 
        id="[1..9]" 
        type="[boolean|integer|longInteger|string|UTCTime|GeneralizedTime|GeneralizedTimeNoFraction|Interval]">
           ...
      </parameter>
    </filterParameters>
  </report>
</reports>

Remarks:

The <parameter> element can have macro-like function values such as {now} and {today}, but usually it is evaluated from a user parameter using expressions.

Currently, the supported macros are:

{now} - gets the current clock time
{today} - gets the current date

Currently, the supported expressions are:

{now} + {userparameterid}
{now} - {userparameterid}
{today} + {userparameterid}
{today} - {userparameterid}

Attributes

Attribute	Description
id	Required attribute. Uniquely identifies the filter parameter when substituting it in the search filter. Range of possible values: 1 to 9.
type	Optional attribute. Specifies the type of the filter parameter that will be substituted in the search filter. This attribute defines the value constraints and the way the underlying value is transformed into string before the substitution. Possible values are: boolean - (true, false) integer - (a integer) longInteger - (a long integer aka 64-bit integer) string UTCTime - (UTC time - YYMMDDHHMMSS.0Z) GeneralizedTime - (generalized time - YYYYMMDDHHMMSS.0Z) GeneralizedTimeNoFraction - (generalized time - YYYYMMDDHHMMSSZ) Interval - (NTDS interval)

Attribute

Description

Required attribute. Uniquely identifies the filter parameter when substituting it in the search filter. Range of possible values: 1 to 9.

type

Optional attribute. Specifies the type of the filter parameter that will be substituted in the search filter. This attribute defines the value constraints and the way the underlying value is transformed into string before the substitution. Possible values are:

boolean - (true, false)
integer - (a integer)
longInteger - (a long integer aka 64-bit integer)
string
UTCTime - (UTC time - YYMMDDHHMMSS.0Z)
GeneralizedTime - (generalized time - YYYYMMDDHHMMSS.0Z)
GeneralizedTimeNoFraction - (generalized time - YYYYMMDDHHMMSSZ)
Interval - (NTDS interval)

Child Elements

None.

Parent Elements

Element	Description
<filterParameters>	Specifies parameters used in a parameterized search filter.