DriveWorks Pro 17: Run Macro in a Loop [send feedback...]

Run Macro in a Loop

The Run Macro in a Loop task will run a macro in the specification the number of times specified by the Start, Limit and Increment Values.

Macros cannot be run while editing a project.

Properties

Property NameDescription
TitleChanges the Title (not the name) of the task.
Macro NameThe name of the macro in the project.
Macro Argument

Provides an optional argument to the macro.

Click here for more information...
DeferTrue to defer the execution of the macro until after the specification has been saved. False to run immediately.

When a Specification is created a copy of the Project file (.driveprojx file) is stored alongside it in a hidden folder. This file is saved when a Specification is transitioned to a non-running state. The Defer property ensures the Task runs after everything else has happened in that Transition, Operation or change in State.

When transitioning a Specification to a paused state, and set a Task to be deferred, it will run after all the changed values have been saved to the Project file.

When a Task is set to be deferred in an Operation then all other Specification Tasks on that Operation would be run first before the Deferred Task is run.

Start ValueControls the initial value of the loop counter.
Limit ValueControls the limiting value of the loop counter.
Increment ValueControls the value added to the loop counter on each iteration, this will be positive to step up and negative to step down.
Counter ConstantOptional. The name of a constant which will receive the loop counter value on each iteration.

Example

When this task is added the properties are static by default.
See How To: Change A Static Property To A Dynamic Property to enable rules to be built on these properties.

Property NameExample RuleExample ResultMeaning
DeferFALSEFALSEFALSE will run this Task immediately.
DeferTRUETRUETRUE would defer this Task until after the specification had been saved.
Macro ArgumentDWCurrentMacroArgument1Will be the Macro Argument used by the Macro running in a loop.This can then be used in rules. Find more information here
Macro Name"Export to table"Export to tableThis is the name of the Macro you want to run.
Counter ConstantDWConstantLoopingConstantDWConstantLoopingConstantWill increase the specified constant every time the loop is carried out.
Increment Value11Will add 1 to the loop counter of each iteration. This is positive so will step up.
Limit ValueTableMaxValue(DWLookupCustomers,1)10The loop counter will be limited to this number of loops. The rule is finding the maximum value that the table goes to and sets that as the limit
Start Value11The loop counter will start at this value

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task does not currently support Status Output Navigation.

Please check the Specification Report for details of Success/Warnings/Failure.

DriveWorks Tech Tips Portal

Copy Table

Shows how you can copy data from one Simple Table to another, remove selected rows and clear the whole table using macros.

View all Tech Tips

DriveWorks Tech Tips Portal is available to DriveWorks Pro customers with an active subscription and support contract.

Tech Tips provide cut down projects that highlight specific functionality for faster and more effective learning.

To access the portal:

  1. Go to https://hub.driveworks.co.uk/tech-tips/
  2. Login with your DriveWorks Pro account credentials, if asked
  3. Click the Visit Tech Tips Portal button for access

The portal provides a search facility, start typing the name of the Tech Tip (as indicated above) to display the Tip you require.

Table of Contents