Using Data Form Scripts

The Script feature enables you to view, modify, and print the script. You enter the syntax in the text box on the Script page.

You can use three types of syntax elements when creating data form scripts: keywords, values, and options. Keywords are on individual lines in the script and are placed to the left of the equal sign. Values are placed immediately after the equal sign to complete the line. Options can be added to a line of script where each is delimited by a comma.

Note:

When a value is required, it must be specified before options. Options are never required and can be in any order.

Sample data form scripts are installed with Sample Applications for Oracle Hyperion Financial Management. The files are located in the Sample Applications folder in the directory to which you installed Financial Management.

Note:

Data entry form script elements are not case-sensitive.

Table 7-1 Data Form Script Syntax

Script Syntax	Description
AddMember	Use in a row definition to allow the user to add data for a member that previously had no data or contained zeros and was suppressed from the form. The option adds an icon to the form that, when clicked, enables the user to select members to add to the form.
BackgroundPOV	Use to specify the background dimension members for the form.
Blank	Use to insert a blank row, column, or cell into the form.
Cn	Use to define each column in a form.
CalcByRow	Use to specify if the row calculation is used when a cell has an intersecting column calculation.
Cell_Link	Use with Link in a row definition to link to another data entry form.
CellText	Use to specify whether the row or column accepts cell text input.
CustomHeader	Use to specify custom header text to be displayed in place of the member label or description. Use in a row or column definition. You cannot use these keywords for Custom Headers: <pre> <textarea> <script> <javascript> <jscript> <vbs> <vbscript> strings such as <XonX=X>, where X = any string
CustomHeaderStyle	Use to assign custom style attributes to a row or column header.
DynamicPOV	Deprecated. Do not use.
FormInputBoxLength	Use to specify the input box width on the form.
FormNumDecimals	Use to specify the number of decimal spaces for the form. This keyword overrides the decimal settings for the cell currency. Use NumDecimals to override this setting for a row, column, or cell.
FormRowHeight	Use to specify the height of all rows in the form.
FormScale	Use to specify the scale for the form.
HeaderOption	Use to specify how dimension headers display in the form. Show labels and/or descriptions, set style attributes, set maximum or fixed width.
Instructions	Use to create instructions in HTML-formatted text and links.
LineItemDetailSinglePeriod	Use to specify if line item detail displays for the selected cell only or for all periods.
Link	Use with Cell_Link to link to another data entry form.
MaxCells	Use to specify the maximum number of cells for a data form.
MaxColsForSparseRetrievalMethod	Use to optimize performance of sparse forms. Use with forms containing more than 10 columns.
NoSuppress	Use to turn off suppression for one or more rows or columns. This setting overrides other suppression settings in the form: SuppressInvalidRows, SuppressNoDataRows, SuppressZeroRows, SuppressInvalidCols, SuppressNoDataCols, SuppressZeroCols.
NumDecimals	Use to specify the number of decimal places for a row, column, or cell. This keyword overrides the decimal settings for the cell currency and the decimal setting for the form FormNumDecimals.
OnDemandRules	Use to specify which on-demand rules are available for the data form.
Override	Use to specify a different POV or calculation for one or more rows or columns or to add style attributes or set the scale. Use in a row or column definition.
HideInPov	Use to specify whether to hide the dimension in the POV.
POVOrder	Use to specify the order of dimension names in the POV.
PrintNumDataColsPerPage	Use to specify the number of columns to print on each page.
PrintNumRowsPerPage	Use to specify the number of rows to print on each page.
PrintRepeatHeadersonAllPages	Use to print headers on each page.
Rn	Use to define each row in a form.
ReadOnly	Use to specify read only rows, columns, or cells.
ReportDescription	Use to specify the description for the form. The description cannot contain an ampersand (&).
ReportLabel	Use to specify the label for the form. These characters are not supported for Data Form labels: Ampersand (&), asterisk (*), backslash (\), colon (:), comma (,), curly brackets ({ } ), double quotation marks (""), forward slash (/), less than and greater than (< >), number sign (#), parentheses ( ), period (.), pipe (\|), plus (+), question mark (?), semi-colon (;), and trailing underscore (_).
ReportSecurityClass	Use to specify the security class for the form.
ReportType	Use to set the form type. The value must be set to WebForm.
RowHeaderPct	Use to resize the row header width in reference to the total width of the form.
SCalc	Use to specify server-side calculations for a row, column, or cell.
Scale	Use to specify scale for a row, column, or cell. Valid values are -12 to 12. This setting overrides the form scale setting. See FormScale.
SelectablePOVList	Use to specify the selectable dimension members in the form.
ShowDescriptions	Use to show descriptions for dimension members.
ShowLabels	Use to show labels for dimension members.
String	Use to add a text string to a column, row, or cell.
Style	Use to specify the style attributes for a row, column, cell, or dimension header.
SuppressColHeaderRepeats	Use to prevent repeated column headers from displaying.
SuppressInvalidCols	Use to prevent invalid cells in from displaying in columns.
SuppressInvalidRows	Use to prevent invalid cells from displaying in rows.
SuppressNoDataCols	Use to prevent columns with no data from displaying.
SuppressNoDataRows	Use to prevent rows with no data from displaying.
SuppressRowHeaderRepeats	Use to prevent repeated row headers from displaying.
SuppressZeroCols	Use to prevent columns with zeros from displaying.
SuppressZeroRows	Use to prevent rows with zeros from displaying.