Regions

Regions are a great way to manage and separate sections of your task. They help you to build specific regions in your task that you can name and comment on and then show or hide that entire area/region by using expand and collapse options. With regions, you can categorize specific steps of your task based on some common functionality. You can use regions to better organize your task by expanding the steps that you need to focus on while the rest may be collapsed and hidden from view (as shown below). Regions are particularly handy when your task contains a significantly large amount of steps that you may wish to format into sections. Regions can be used multiple times in a single task. Additionally, nested regions (region within a region) can be created to further expand its capabilities.

Creating and Populating Regions


You can create an empty region and later add steps to it or create one pre-populated with selected steps. When creating a new region, its default name is always 'New Region' therefore, it is important that you provide a unique name for newly created regions in order to avoid confusion.

To create an empty region:

  1. Highlight the line in the Steps pane you wish to place the region.

  2. Click the Create Region button from the Task Builder Ribbon's Step command group or right-click and select Create Region. A new region is added to the section of the Steps pane that you initially highlighted.

  3. Click the newly created region to rename it.

To create a region pre-populated with steps:

  1. Highlight the steps in the Steps pane you wish to place in a region (selected steps must be sequential).

  2. Click the Create Region button from the Ribbon's Step command group or right-click and select Create Region. A new region is added to the Steps pane populated with the steps you initially selected.

  3. Click the newly created region to rename it.

To add an action/activity to an existing region:

  1. Expand the region you wish to add an action to by double-clicking the region name or clicking the expand symbol to the left of the region name.

  2. Drag the desired action/activity from the Available Actions pane onto a selected part of the region. A red line will appear (as shown below) signifying the section of the region in which the action will be placed.

To add existing steps to a region:

  1. Expand the region you wish to add steps to by double-clicking the region name or clicking the expand symbol to the left of the region name.

  2. Select one or more existing steps from the Steps pane (selected steps must be sequential in order).

  3. Drag the step(s) to the desired part of the region. A red line will appear signifying the section of the region in which the steps(s) will be placed.

To create a nested region (region within a region):

  1. Expand the region you wish to add a sub-region to.

  2. Highlight the steps within that region that you would like to place in the sub-region.

  3. Click the Create Region button from the Task Builder Ribbon's Step command group or right-click and select Create Region. A new sub-region is added inside the parent region.

  4. Click the newly created sub-region to rename it.

 

Managing Regions


To expand all regions simultaneously:

  1. Select Expand All Regions from the Ribbon's Step command group.

Or

  1. Press Shift+E

To collapse all regions simultaneously:

  1. Select Collapse All Regions from the Ribbon's Step command group.

Or

  1. Press Shift+C

To clear one or more regions:

  1. Select the region you wish to remove. To select multiple regions, hold down CTRL during selection.

  2. Right-click and select Clear Regions.

  3. To clear all existing regions, right-click and select Clear All Regions.

See Also

Regions Debug Pane

Troubleshooting Tasks