{MASK}

Command

The MASK command overwrites the text in each output row with the specified characters at the specified position.

Syntax

{ MASK charPosition "replacement" [ charPosition "replacement" ] }

charPosition	Character position at which to start replacing text.
"replacement"	New text, enclosed by quotation marks, with which to overwrite the original output.

Description

This command inserts text or other information into each subsequent output line of a report, overwriting any output in these positions. All nonblank characters in the text overwrite appears in the output line.

To create a mask of a blank character that overwrites output, enter ~ (the tilde character), rather than a blank space. The ~ is output as a blank space mask.

In addition to constant text, this command can use keywords to insert special strings into the report. These keywords begin with a "*" and must be entered. These are identical to the * keywords under the TEXT command, and are listed here for convenience. For a more complete discussion of * keywords, please turn to the TEXT command.

You may include multiple sets of positions and text in a single MASK command.

*APPNAME	The name of the application as set in the application definition.
*ARBOR	The version information from the Hyperion Essbase Application Server.
*COLHDRnumber1 number2	The column heading members from the report, usually used with SUPCOLHEADING.
*COLHDRFULL	The full column heading, along with underlines of the column headings and a 1-line skip.
*CURRENCY	The currency conversion label that indicates to which currency the data values have been converted at report time with the CURRENCY command.
*DATE	The date the report was generated.
*DATETIME	The date, followed by the time, the report was generated.
*DBNAME	The name of the data base within the application.
*EDATE	The date in European (dd/mm/yy) format.
*EDATETIME	The European format date (dd/mm/yy), followed by the time.
*MACHINE	The network name for the machine that is running the Server.
*PAGEHDRnumber	The page member heading for the report, usually used with SUPPAGEHEADING.
*PAGENO	The page number for the current page.
*PAGESTRING	The page number preceded by the text "Page:"
*TIME	The time the report was generated.
*TIMEDATE	The time followed by the date the report was generated.
*TIMEEDATE	The time followed by the European format (dd/mm/yy) date.
*USERNAME	The name of the user generating the report.

Example

The following example is based on Sample Basic.

<ROW (Year, Measures, Product, Market, Scenario)
{SUPPAGEHEADING}
{ROWREPEAT}
{DECIMAL 2}
{SUPCOMMAS}
{MASK 3 "," 22 "," 40 "," 55 "," 74 ","}
<CHILDREN Qtr1
Sales
<CHILDREN Colas
East
Budget
     !

Jan,        Sales,       100-10,      East,       Budget,        1690.00 
Jan,        Sales,       100-20,      East,       Budget,         190.00 
Jan,        Sales,       100-30,      East,       Budget,          80.00 
Feb,        Sales,       100-10,      East,       Budget,        1640.00 
Feb,        Sales,       100-20,      East,       Budget,         190.00 
Feb,        Sales,       100-30,      East,       Budget,          90.00 
Mar,        Sales,       100-10,      East,       Budget,        1690.00 
Mar,        Sales,       100-20,      East,       Budget,         200.00 
Mar,        Sales,       100-30,      East,       Budget,         100.00

Notes

• MASK is a setting command.
• To replace a space, use a ~ (the tilde character).
• If you want to produce an output file in comma-delimited format, use the SUPCOMMAS command, as in the example, to suppress the commas in numeric values. You can also use the SUPPAGEHEADING command to suppress page headings in the comma-delimited file.

INCMASK
SUPMASK
TEXT

Copyright (c)1991-2000 Hyperion Solutions Corporation. All rights reserved.