Report Writer Syntax

Overview
Syntax
Command Groups
Command List

This topic contains the following information:

Report Delimiters
Syntax Guidelines
Referencing Static Members

Report Delimiters

The < or {} delimiters are required for Report Writer commands. If you do not use a delimiter, Report Writer assumes that the command name is a member name.

Delimiter Use in Report Writer: Example

{} Encloses report formatting commands {SUPFORMATS}

< Precedes layout and member sorting, selection, calculation, and some formatting commands <PAGE

Syntax Guidelines

Separate commands with at least one space, tab, or new line. Report processing is not affected by extra blank lines, spaces, or tabs.
Enter commands in either upper or lowercase. Commands are not case sensitive. If the Database Outline is case-sensitive, then the member names used in the report script must match the outline.
To start report processing, enter the ! report output command (exclamation point or "bang"), or one or more consecutive numeric values. You can place one or more report scripts, each terminated by its own ! command, in the same report file.
You can group more than one format command within a single set of curly braces. For example, these formats are synonyms:

      {UDATA SKIP}
      {UDATA} {SKIP}

Enclose member names that contain spaces or the member name "Default" in double quotes; for example, "Cost of Goods Sold" "Default".
If a formatting command is preceded by three or more of the characters "=," "-," and "_," the Report Extractor assumes that the characters are extraneous underline characters and ignores them. For example, ==={SKIP 1}
Use // (double slash) to indicate a comment. Everything on the line following a comment is ignored by the Report Writer. Each line of a comment must start with a double slash.

Referencing Static Members

You can enter static (non-changing) member names, such as Sales and COGS, directly into the report script. For static member names, use staticMbrDefinition syntax, as described below:

Command

A staticMbrDefinition specifies the member to select.

Syntax

mbrName [ mbrName ]

mbrName

Dimension or member name of member to specify. When specifying multiple member names, separate them with spaces. Enclose member names in double quotes if they contain spaces or consist of numbers. For example: "Cost of Goods Sold" or "100-10"

Description

A static member definition specifies a database outline member in a report specification. This definition does not automatically reflect changes to the Database Outline. If you change a member name in the Database Outline, you must manually update each report script associated with that Outline.

Example

Year

Selects the member Year.

Sales "Cost_of_Goods_Sold"

Selects the members Sales and Cost_of_Goods_Sold.

Delimiter	Use in Report Writer:	Example
{}	Encloses report formatting commands	{SUPFORMATS}
<	Precedes layout and member sorting, selection, calculation, and some formatting commands	<PAGE