Property Arguments

Property arguments are a way to consolidate expanded references to a single value which is then used in the calculation. You use property arguments to perform calculations on an aggregate row, column, or cell. The next sections explain the following property arguments:

Aggregate Property Argument

An aggregate row, column, or cell contains multiple rows, columns, or cells, respectively.

The aggregate property argument is the last argument in the following mathematical function syntax:

   FunctionName(GridName.Gridelement[segment(range)].property)

You apply aggregate properties to a row, column, or cell reference. The following table lists the aggregate properties:

Table 36. Aggregate Properties 

Properties

Description

Average

Returns the average of a row, column, or cell. The calculation excludes #missing and #error values.

AverageA

Returns the average of a row, column, or cell. The calculation includes #missing and #error values.

Count

Returns the number of values in a row, column, or cell. The calculation excludes #missing and #error values.

CountA

Returns the number of values in a row, column, or cell. The calculation treats #missing and #error values as zero (0).

Max

Returns the maximum value of a row, column, or cell.

Min

Returns the minimum value of a row, column, or cell.

Product

Returns the product of rows or columns.

Sum

Returns the sum of a row, column, or cell.

When used as a mathematical function argument, the default for property is the same as the function. In the following example the default property is Average:

  Average(row[2])

When not used as a mathematical function argument, the default for property is sum. In the following example the default property is the sum of an aggregate row:

   row[2]

Reference Property Argument

A reference property argument specifies how to treat formula reference results and is used in conjunction with the other properties.

There is one reference property argument: IfNonNumber/IFFN.

IfNonNumber specifies a replacement of #Missing and #Error values with a specific numeric value. The syntax is:

AXIS[segment(range)].IfNonNumber(arg).AggregateProperty

Argument

Description

AXIS

One of the following keywords: row, column, or cell.

Optional.

Segment(range)

Indicates any valid axis reference, such as a row number, column letter.

IfNonNumber

Indicates how to treat missing or error data within the Axis Ref.

(arg)

Indicates what number to use if missing or error data is encountered within the AxisRef.

AggregateProperty

The aggregate function is used for aggregate segments. For more information on AggregateProperty, see Aggregate Property Argument.

Optional.

For example:

If cell[1,A] = 3 and

cell[1,B] = #Missing,

The expression:

  cell[1,A] / cell[1,B] 

returns #Error.

The expression:

  cell[1,A] / cell[1,B].ifNonnumber(1) 

replaces cell[1,B] with 1 and returns a 3.

Note:

If you use suppression for #Missing or #Error in a grid, and the grid contains a formula row or column that uses the IfNonNumber property, #Missing and #Error remain suppressed.

Note:

When using a Financial Management database connection, and the MissingValuesAreZeroInFormulas (formerly MissingValuesAreZeroInFormulasInHFM) option in JConsole is set to one (1), the #Missing value is zero regardless of the setting of the IfNonNumber property. However, if the file is set to zero, the IfNonNumber property behaves as described.

For information on JConsole, see the “Property Information” topic in the Oracle Hyperion Financial Reporting Workspace Administrator's Guide.