customCellValidatePre

Description

Use customCellValidatePre for custom behavior when focus leaves a cell, before default Planning logic runs. For example, you can compare the value a user entered for the cell to another value and display an alert if the variance is too great or out of range. You can define a spreading algorithm that occurs when the focus leaves a cell, replacing the default spreading algorithm. For example, Planning usually spreads by time period, but you can write custom JavaScript that pre-aggregates the data on the client side before writing values back to Essbase.

After this function runs, if customCellValidatePre returns True, Planning default logic runs. If it returns False, no additional logic follows the custom code. Data forms use your custom code and skip the default Planning logic, which could cause users to submit invalid data.

SampleValidateData.js includes an example that executes additional validation when the focus leaves a cell. When the focus leaves a cell, the code compares the value the user entered for the current year to last year’s value. If the current year value is over 10% larger than the previous year, a message is displayed.

Arguments

Argument

Description

Row

An integer that defines the row for the cell.

Col

An integer that defines the column for the cell.

Cell

A handle for the HTML input artifact.

Returns

Argument

Description

True

The Planning default logic runs after this code completes.

False

No further logic runs after this code completes.

See Also

customCellValidatePost