|
This online help file is for the Advanced Workflow Engine v8. For other versions, please refer to http://help.globalscape.com/help/index.html. (If the Index and Contents are hidden, click Show Contents pane in the top left corner of this topic.) |
The Variables debug tool is ideal in debugging objects that may contain dynamic data, such as variables, arrays and datasets. When a task runs, the Variables tab generates real-time information about such objects including their initial and current value. You can examine the 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 the Variables tab to determine if the current values have been properly set or modified.
The Variables pane generates information divided into seven columns:
|
Column Name |
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 public or private. Controls how variables are accessed externally. |
|
Scope |
Whether the item is Local or Task. Local is local to the used function, Task is a task variable which is considered global to the whole task. |
Right-click anywhere inside the Variables pane to view the following menu items.
|
Menu Item |
Description |
|
Properties |
Opens the properties dialog of the selected object for viewing or editing purposes. |
|
Inspect |
Opens a dialog box allowing you to better inspect the selected object. |
|
Add Variable |
Adds a variable to the current task (the same as selecting Create Variable from the Available Actions pane). |
|
Add Array |
Adds an array to the current task (the same as selecting Create Array from the Available Actions pane). |
|
Rename |
Renames the selected object. |
|
Delete |
Deletes the selected object. |
|
Delete Locals |
Deletes all local variables. |
|
Delete All |
Deletes all objects listed in the Variables pane. |
|
Stay On Top |
If enabled, after undocking this panel, it will stay on top of all other undocked panels. This option is disabled by default. |
|
Dockable |
If enabled, allows the panel to be docked to its base once it is undocked. If disabled, you will not be able to re-dock the panel once it is undocked. This option is enabled by default. You can undock a panel by holding down and dragging its title bar away from the main window or double-clicking the title bar. |
Variables can be added, edited, or deleted directly from the Variables Debug pane. When you edit variables in this way, Create Variable steps are added, changed, or deleted in the task.
To edit an existing variable:
In the Variables Debug pane, double-click the variable. Then edit the properties in the dialog box and click OK.
To add a variable:
Right-click anywhere in the Variables Debug pane and select Add. Then enter the variable properties in the dialog box and click OK.
To delete a variable:
In the Variables Debug pane, right-click the variable and select Delete.
or
In the Variables Debug pane, select the variable and then press the Delete key on your keyboard.
NOTE: As with all Debug panes, selecting Stay On Top from the right-click menu causes the view to remain on top of all other Task Builder panes. Selecting Dockable allows the view to be docked along the bottom of the Task Builder below the Steps pane. If Dockable is not selected, the window will not dock to any other views or panes.