PlanningAnnotations

PlanningAnnotations is a text function that retrieves the critical notes or comments associated with a cell’s PlanningUnit from the Planning Details database connection. PlanningUnits are a combination of Scenario, Version, and Entity and are derived in Financial Reporting through cell references in a grid.

The function syntaxes are:

<<PlanningAnnotations("GridName", Row, Column, Page, Attributes,Range)>>
<<PlanningAnnotations("GridName", Row, Column, Page, Attributes)>> (assumes “All” for Range paramter)

Examples

<<PlanningAnnotations(“Grid Name”, 1,a,1,All, All)>>
<<PlanningAnnotations(“Grid Name”, 100,AB,10,All, All)>>
<<PlanningAnnotations(cur, cur,a,cur,Text & Title & Author, Top 5)>>
<<PlanningAnnotations(cur, 315, AB, 255, Text&Title&Author, Top 5)>>
<<PlanningAnnotations(cur, cur A, Cur, PlanningUnit, Top 5)>>
<<PlanningAnnotations(“cur, 123, ABC, 101, PlanningUnit, Top5)>>
<<PlanningAnnotations(“Grid1, 1, current, cur, Title & Text, Bottom 10)>>
<<PlanningAnnotations(“Grid1, 105, ABC, cur, Title & Text, Bottom 10)>>
<<PlanningAnnotations(“Current”, 34, BB, cur, “All”, Top 40)>>
<<PlanningAnnotations(cur, cur, A cur, “Text & Title & Author”, Top 5)>>
<<PlanningAnnotations(cur, cur, A, cur, “Text&Title&Author, “bottom15”)>>
<<PlanningAnnotations(cur, 1(3), A(B), cur, Title&Author&Date&Text, “All”)>>
<<PlanningAnnotations(cur, 1(3), A(B), cur, “Title&Author&Date&Text, “All”)>>

The following table provides a summary of the PlanningAnnotations parameters.

Argument

Description

GridName

The name of a grid. GridName is a required parameter.

Row

A numeric value representing the row number of the grid. The first row in a grid has an index of 1, the second row has an index of 2, and so forth. Row is a required parameter.

Column

A letter representing the column of the grid. The first column in a grid has an index of A, the second column has an index of B, and so forth.

Column is a required parameter.

Page

A numeric value representing the page dimension index of the grid. The first page dimension in a grid has an index of 1, the second page dimension has an index of 2, and so forth. Page is a required parameter.

Attributes

The Attributes parameter may include any of the following values: All, Title, Author, Date, Text, PlanningUnit. PlanningUnit is the combination of scenario, version, and entity and is derived from the GridName, Row, column, and Page. The Attributes parameters may be rearranged in the preferred order of output. Each attribute must be separated with an ampersand (&).

Range

You can use the keywords All, Top, or Bottom. to select a certain number of annotations from the top or bottom of an output, or all annotations; for example:

  • All returns all annotations

  • Top 5 returns the first five annotations

  • Bottom 10 returns the last ten annotations

  • Bottom 1 returns the last annotation

Example

For this example you retrieve annotation text that is in row 1, column A, of a grid which is on the current page. You want to display the bottom 3 annotations and all attributes associated with the annotation (title, author, date, text, and planning unit).

Note:

If you know that your annotations span multiple pages, Hyperion recommends that you place the function in a text row on a grid, then select Adjust Row Height to Fit on the Row Properties sheet so the text can span multiple pages. This option is not available in a text object. When you use annotations in a text object, only the portion that fits on the page is printed. However, everything is included in HTML output.

Annotations are returned chronologically in descending order by date, with the most recent annotations on top and the oldest annotation on the bottom.

The resulting annotation text resembles the following example:

Title: Status - Under Review

Author: John Smith

Date: Mar 25, 2003 10:32:49 AM

Planning Unit: Budget, 1st Draft, East

Text: Please review and approve

— — — — — — — — — — — — — — — — —

Title: Status - Not Signed Off

Author: Mary Brown

Date: Mar 21, 2003 2:59:11 PM

Planning Unit: Budget, 1st Draft, West

Text: Sorry, Try Again

— — — — — — — — — — — — — — — — —

Title: Status - Under Review

Author: Admin

Date: Mar 21, 2003 2:54:16 PM

Planning Unit: Budget, 1st Draft, South

Text: Please review and approve budget for 1st draft

Note:

This function supports the Current keyword when used in a grid (not text box object). For information and examples, see Current / Cur Keyword.

Additional Information: