Menus

The Rules Editor has a full set of menus for creating, editing, and managing rules. Keyboard shortcuts are provided for the more commonly used menu options.

The following table describes the options in the File menu.

Name

Description

Import

Opens a file browse dialog so you can select a text file to import. Imported text will overwrite the current rule if one exists.

Save

Saves the current rule to the TM1® server.

Save As...

Saves the current rule to an external rule .rux file.

Check Syntax

Checks the current rule for syntax errors.

Print...

Opens the Print dialog box so you can print the current rule.

Print Preview

Opens the Print Preview window where you can view a sample printed version of the rule before sending it to a printer.

Exit

Closes the Rules Editor.

The following table describes the options in the Edit menu.

Name

Description

Undo

Undoes the last edit.

Multiple levels of undo are supported.

Redo

Reverses the last undo command.

Cut

Removes the selected text and places it in the clipboard.

Copy

Copies the selected text to the clipboard.

Paste

Pastes the contents of the clipboard into the Rules Editor.

Select All

Selects the entire contents of the Rules Editor.

Find

Opens the Find dialog box so you can search for text in the rule.

Find / Replace...

Opens the Find/Replace dialog box to search for and replace text.

Find Next

Locates the next occurrence of the text for which you are searching.

Toggle Bookmark

Turns a bookmark on or off for the current line of code.

Next Bookmark

Moves the cursor to the next available bookmark.

Previous Bookmark

Moves the cursor to the previous available bookmark.

Clear All Bookmarks

Removes all bookmarks.

Comment Selection

Adds a comment symbol # in front of all lines in the currently selected text to exclude the lines from the compiled rule.

Note: Comment length is limited to 255 bytes. For Western character sets, such as English, a single character is represented by a single byte, allowing you to enter comments with 255 characters. However, large character sets, such as Chinese, Japanese, and Korean, use multiple bytes to represent one character. In this case, the 255 byte limit may be exceeded sooner and not actually allow the entry of 255 characters.

Uncomment Selection

Removes the comment symbol # from in front of all lines in the currently selected text to include the lines in the rule.

Indent

Indents the currently selected lines.

Unindent

Removes the indent from the currently selected lines.

Goto Line...

Displays the Go To Line dialog box so you can enter and jump to a specific line number in the Rules Editor.

The following table describes the options in the View menu.

Note: Any changes you make to the settings on the View menu are saved when you exit the Rules Editor and are automatically re-applied the next time you open the Rules Editor.

Name

Description

Word Wrap

Turns on/off the word wrap feature so lines of text either extend to the right or wrap to display within the Edit pane.

Line Numbers

Turns on/off line numbers.

Function Tooltips

Turns on/off the display of function tooltips.

Auto-Complete

Turns on/off the auto-complete feature when typing in the Edit pane.

Toolbar

Turns on/off the display of the main toolbar.

Status Bar

Turns on/off the display of the status bar at the bottom of the Rules Editor.

Control Objects

Turns on/off the display of TM1 control objects when selecting cubes.

Expand All Regions

Expands all of the user-defined regions in the current rule to show all lines.

Collapse All Regions

Collapses all of the user-defined regions in the current rule to hide all lines that are included in a region.

The following table describes the options in the Insert menu.

Name

Description

Function

Displays the Insert a Function dialog box to enter a new function into the current rule.

Cube Reference

Displays the Insert Cube Reference dialog so you can insert a DB function.

The following table describes the options in the Tools menu.

Name

Description

Preferences...

Displays the Preferences dialog where you can set the font attributes such as font type, size, and color to be used in the Edit pane.

Options...

Displays the Control Options dialog where you can adjust the global settings for the Rules Editor.