Use the process editor in Planning Analytics Workspace

These features help you create and manage processes in the Planning Analytics Workspace process editor.

Open the process editor in a separate window

To open an the editor in a separate window, click Open tab in floating window open tab in floating window.

For more information, see Open editors in a separate window.

Procedure links

A TurboIntegrator process contains four procedures: Prolog, Metadata, Data, and Epilog. The Script tab on the process editor includes links to each procedure so you can quickly jump to the procedure you want to edit.

Procedure section collapse/expand

Click the small arrow next to any procedure section to collapse or expand the contents of the procedure.

Expand/collapse button

Auto-completion

You can use the CTRL+SPACE keystroke combination, or type or pick items, to choose applicable items in the process editor.

  • If you use CTRL+SPACE at the beginning of an empty line in the process editor, you'll see a list of categories:

    Categories drop-down list.

    Click any of the categories to see a list of specific of items, then click an individual item to insert it into the editor.

  • When you begin typing a function name, a list presents all functions that start with the characters you've typed. You can then click a function to insert it into the editor.
  • When the cursor is positioned immediately before a parameter placeholder in a function, use CTRL+SPACE to display a list of valid parameter values, or in the case when there is only a single valid parameter value, to insert the value. If the cursor is positioned after a comma following a parameter, CTRL+SPACE lets you pick another parameter value of the same type as the previous parameter. For example, if the cursor is positioned after comma following a dimension name in the CubeCreate function, you can pick another dimension name to insert into the function.

Code snippets

Click the snippet icon the process editor snippet icon on the Script tab of the process editor to insert a predefined code snippet into the process.

The code snippets are provided for repetitive tasks that users perform often, making the process less error-prone. For more information, see Insert a code snippet into a process.

Function list

You can click the process editor function icon on the Script tab of the process editor to quickly insert a TurboIntegrator function into the process.

When you click the process editor function icon, you see a list of function categories. Click a function category to see the available functions within the category, then click a function to insert it at the cursor in the process editor.

The function is inserted with placeholders for required parameters. You must replace the placeholders with valid parameter values. For example, if you use the function list to insert the ATTRN function into your process, you'll see this:

ATTRN( «dimension», «element», «attribute» );

You must replace the <<dimension>>, <<element>>, and <<attribute>> placeholders to successfully return a numeric attribute value with ATTRN.

Shortcut keys

There are many shortcut keys available in the process editor. You can use these keys to edit statements, find and replace text, and navigate through the statements in the process editor.

To see a full listing of shortcut key combinations, click Shortcuts icon on the Script tab of the process editor.

Error highlighting

Syntax errors in your process script are indicated by an error symbol red error symbol next to the line number in which the error occurs. Syntax errors are also highlighted with a pink background in the process editor.

You can hover over either the error symbol or the highlighted syntax error to view a description of the error.

errors in the process editor

In this example, the DIMSIZ function is incorrectly spelled DIMSIZE. The incorrectly spelled function is highlighted and the error description indicates that the highlighted item is not a valid TM1 function.

Line wrapping

To enable or disable line wrapping in the Script tab on the process editor in the editor, click Options icon.

Text customization

To change the font and size of the text displayed in the Script tab on the process editor, click Font selection icon.

Locate the process in the Databases tree

You can click the Find in tree button to immediately locate the process in the Databases tree.

Find in tree button