CreateBackgroundScript Method

VirtualUserScript CreateBackgroundScript Method

C# API

Creates a new background script and starts it if requested.

Namespace: Facilita.Fc.Runtime
Assembly: fc_clr (in fc_clr.dll) Version: 9.5.8.37

Syntax

public void CreateBackgroundScript(
	string id,
	string vuScriptClassName,
	AutomaticStopCriteria stopCriterion = AutomaticStopCriteria.StopImmediatelyAtEndOfVirtualUser,
	ExecutionFlags executionFlags = ExecutionFlags.SingleShot|ExecutionFlags.LongRunningScript,
	TimeSpan pauseBetweenScriptsLoops = null,
	Nullable<TimeSpan> autoStopTimeout = null
)

public void CreateBackgroundScript(
	string id,
	string vuScriptClassName,
	AutomaticStopCriteria stopCriterion = AutomaticStopCriteria.StopImmediatelyAtEndOfVirtualUser,
	ExecutionFlags executionFlags = ExecutionFlags.SingleShot|ExecutionFlags.LongRunningScript,
	TimeSpan pauseBetweenScriptsLoops = null,
	Nullable<TimeSpan> autoStopTimeout = null
)

Parameters

id: Type: System String
Unique script ID, identifying the background script.

vuScriptClassName: Type: System String
Fully qualified script's class name.

stopCriterion (Optional): Type: Facilita.Fc.Runtime.BackgroundScripting AutomaticStopCriteria
Automatic stop criterion, describing how and when to terminate the background script (if at all).

executionFlags (Optional): Type: Facilita.Fc.Runtime.BackgroundScripting ExecutionFlags
Bitwise flags describing execution of the script.

pauseBetweenScriptsLoops (Optional): Type: System TimeSpan
If script is run in a loop (executionFlags contain ExecutionFlags.Loop) then you can set the pause between such loops.

autoStopTimeout (Optional): Type: System Nullable TimeSpan
Automatic timeout is used when stopCriterion is not AutomaticStopCriteria.NeverStopAutomatically. If it is null, default setting from VU Group is used instead.