@FORMATDATE

The @FORMATDATE calculation function for Essbase returns a formatted date string.

Syntax

@FormatDate(date, date_format_string)

Parameters

<date>

A number representing the input date. The number is the number of seconds elapsed since midnight, January 1, 1970. To retrieve this number, use any of the following functions: @TODAY, @TODATEEX, or @DATEROLL.

Date-time attribute properties of a member can also be used to retrieve this number. For example, @AttributeVal("Intro Date"); returns the product introduction date for the current product in context.

date_format_string

One of the following literal strings (excluding ordered-list numbers and parenthetical examples) indicating a supported date format.

"mon dd yyyy" (Example: mon = Aug)
"Month dd yyyy" (Example: Month = August)
"mm/dd/yy"
"mm/dd/yyyy"
"yy.mm.dd"
"dd/mm/yy"
"dd.mm.yy"
"dd-mm-yy"
"dd Month yy"
"dd mon yy"
"Month dd, yy"
"mon dd, yy"
"mm-dd-yy"
"yy/mm/dd"
"yymmdd"
"dd Month yyyy"
"dd mon yyyy"
"yyyy-mm-dd"
"yyyy/mm/dd"
Long format (Example: WeekDay, Mon dd, yyyy)
Short format (Example: m/d/yy)

Notes

Using an invalid input date returns an error.
Using extra whitespace not included in the internal format strings returns an error.
This function interprets years in the range 1970 to 2029 for yy format. Therefore, if the function is invoked using a date format mm/dd/yy for June 20, 2006, the returned date string is "06/20/06".

Example

Assume the outline has a date type member MyDate1.


Profit (If(@ToDateEx("yyyy-mm-dd", @FormatDate(@Today(), "yyyy-mm-dd")) == MyDate1 )
     Profit=99;
Endif;)