Spectre Flow Calc Process Object

Each object has an area where you can enter comments. It is DI best practice to enter a note for every object in a Spectre Flow script.

Every Spectre Flow node comment area is Markdown-enabled. For more information, see Workbench Markdown Editor.

The Calc Process object column grid section displays information on columns added or replaced by expressions.

Attribute	Description
Name	Defines the name of each column added or replaced by a calc expression.
Func	Click the function icon () to open the Edit Expression window.
Expression	Defines Spectre expressions that run when the Calc Process object runs.
Replace	If true, the calculation result replaces the value of the named column. Also if true, the Name attribute must match a currently existing column name. If false, a new column is added and the calculation results are entered in the new column.
Props	Opens the Edit [Column] properties window.
Comment	Defines a comment for the expression.

To access column properties, select a column from the Column List. The following attributes are common column attributes. For a list of all column attributes, including attributes specific to certain data types, see Spectre Flow Column Tags.

Attribute	Description
Name	Read only attribute displaying the name of the column.
Type	Specifies the data type of the column. Available data types are string, integer, double, fixed100, date, datetime, period, and boolean.
Sort By	Defines another column to sort by when this column is sorted. For example, setting Month Number as the Sort By column for Month sorts months by their number instead of their alphabetical order (1 (Jan), 2 (Feb), 3 (Mar), etc.).
Label	Defines a display name for a column. This name is displayed in ProDiver and DivePort, while calculations and other technical processes use the value in the Name attribute.
Required Dimension	Sets a column to behave like a classic Info Field. In ProDiver, the info field is available as a column that you can add to other columns displayed in a dive. For example, to see the Address column requires that the Customer column is available. Setting a Required Dimension Select the column you want to define as an Info Field. Select Required Dimension in the Properties pane. Locate and select the core dimension from the list. The first column is only available when the second column is displayed in the client.
Suggested Dimension	Allows you to promote or demote a column. Set to True to promote a numeric column type to become a diveable dimension and have it appear in the ProDiver console. Set to False to demote a column from classification as a dimension so it does not appear in the ProDiver console. When set to False, the new dimension does not appear in the console (which requires dimcount processing), but it can be promoted to a dimension for diving—equivalent to the concept of a dynamic dimension for a classic model. Using Required Dimension on a column effectively sets Suggested Dimension to False.
Comment	Defines a comment that describes this column.

The Edit Expression window is a dedicated interface for writing Spectre expressions. Each pane of the window is numbered and described below.

1. Column Grid—Lists each available column from the input data flow and shows each column's data type. Double-click the column to automatically insert a value("Column Name") function into the expression editor.

2. Expression Editor—Defines the Spectre expression. Auto-complete functionality is available.

3. Documentation—Displays the grammar, summary, and help link for a selected function. Click or highlight a function in the expression editor to see documentation.

4. Errors—Displays any warnings or errors for the expression in the expression editor.