Extensions.Job.SetProgressInfo

From emotive
Jump to navigation Jump to search

Classification

Name SetProgressInfo
Short Description Sends progress information to the tester.
Class Action
Extension OTX Job extension
Group Job related actions
Exceptions InvalidStateException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Job.SetProgressInfo(NumericTerm progress);

Description

The SetProgressInfo will send progress information in the form of an integer value to the tester. The value represents a percentage to completion and will be a number between 0 and 100. In case the provided value is smaller than 0, the OTX runtime will set the value to 0. In case the provided value is higher than 100, the OTX runtime will set the value to 100.

Properties

Name Data Type Class Default Cardinality Description
Progress Numeric Term - [1] Represents the progress information as percentage to completion (0..100). Float values will be truncated.

OTL Examples

/// Local Declarations

/// Flow

Job.SetProgressInfo(50);

See also

SendFinalResult
SendIntermediateResult
SetJobInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc