Debug Panel - Variables

The Variables debug panel is ideal in debugging objects that may contain dynamic data, such as variables, arrays and datasets. When a task runs, this panel generates real-time information about such objects including their initial and current value. You can examine content without inserting additional steps to output the values. Similarly, you can insert breakpoints at certain points in your task to halt execution and view this panel to determine if the current values have been properly set or modified.

Parameters

The Variables panel generates information divided into seven columns:

Column Header

Description

Name

The name of the selected  variable, array or dataset.

Type

The type of data being displayed. This can be either a variable, array, dataset or field (associated to a dataset).

Initial Value

Before the task is run for the first time in a Task Builder session, this field contains the initial value of the variable as set in the variable's / array's properties. If no value was set, this field is blank. An array or dataset can contain multiple rows and columns. During runtime, this section will list the initial value of the rows and columns associated to each array/dataset.

Current Value

This field reflects the current value of the variable, array or dataset during task execution.

NOTE: If Real-Time Variable Insight is enabled in the Debugger Preferences, the value is updated after each step executes. If Real-Time Variable Insight is not enabled, the variable Current Value field is updated only when the task is paused, when a breakpoint is encountered or when the task ends.   

Description

A description of the variable or array as set in the associated Create Variable or Create Array properties dialog. The description does not affect variable/array performance at runtime.

Access

Whether the object is public or private. Controls how variables are accessed externally.

Scope

Specifies whether the variable's scope is Local or Task:

  • Local - Specifies that the variable is local to the current context or scope. Usually, this means the procedure or function you are currently executing.

  • Task - Specifies that the variable is a task variable which is considered global to the entire task.

Context Menu

Right-click anywhere inside the Variables panel to view the following menu items.

Item

Description

Properties

Opens the properties dialog of the selected object for viewing or editing purposes.

Inspect

Opens a dialog box allowing you to further inspect the selected object.

Jump to

Jumps to the step number in the Steps panel associated to the object.

Sort

Sorts the list of objects in the following order:

  • Declaration (default) - Sorts by order of declaration.

  • Ascending - Sorts in ascending alphabetical order.

  • Descending - Sorts in descending alphabetical order.

Add Variable

Adds a variable to the current task (identical to selecting Create Variable activity from the Actions panel).

Add Array

Adds an array to the current task (identical to selecting Create Array activity from the Actions panel).

Delete

Deletes the selected object.

Delete Locals

Deletes all local variables.

Delete All

Deletes all objects listed in the Variables panel.

Managing Variables

Variables can be added, edited, or deleted directly from the Variables debug panel. When you edit variables in this way, Create Variable steps are added, changed, or deleted in the task.

To edit an existing variable

  1. In the Variables Debug panel, double-click the variable or right-click the variable and select Properties from the context menu that appears.

  2. Edit the desired properties in the dialog box and click OK when finished.

To add a variable/Array

  1. Right-click anywhere inside the Variables debug panel and select Add Variable or Add Array from the context menu that appears.

  2. Enter properties for the variable/array in the properties dialog box and click OK when finished.

To delete a variable/Array