Stop Timer Action

Declaration

<AMSTOPTIMER SESSION="Text" RESULTVARIABLE="Text" SCALE="Text" />

See Also

Timer Actions-Setting Properties

Description

Stops a timer session that was previously started using a Start Timer step. The elapsed time is output to a user specified variable using a specified scale.

Practical Usage

Used in conjunction with the Start Timer action to record the elapsed time for a step or series of steps.  This action stops the timer and records the elapsed time in a variable.  

Parameters

General Tab

Timer Name

Text, Optional - Default "TimerSession1"
MARKUP: SESSION="TimerSession2"

Specifies the name of the timer session established by the Start Timer action. This allows several timers to be running simultaneously.

Populate Variable With Elapsed Time

Text, Required
MARKUP: RESULTVARIABLE="VariableName"

Specifies the variable to populate with the timer reading.

Time Scale

Text, Optional - Default "seconds"
MARKUP: SCALE="Minutes"

Specifies the scale to be used in calculating the time. Options are: hours, minutes, seconds, milliseconds.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMSTOPTIMER SESSION="TimerSession2" RESULTVARIABLE="VariableName" SCALE="Minutes" />