Class Track

"Ramp" is defined as Track parallel repeating with a "start interval" and/or "end interval". The use of parallel repeat renewal is required for ramp adjustments to work properly.

This method may be called at any time, including when the ramp is paused or pausing, or when it is already resuming.

This method institutes the new ramping request, but does not wait for the specified ramping goal to actually be reached, as that might occur much later.

Each server on which the Distribution of the Track resides will hold at the current number of virtual users at the time at which the request reaches that server, which may be some time later than when the Script executes, depending upon the number of servers in the Composition, network communication time, etc.

For multi-server Compositions, the request may take some time before it is accepted by all of the servers on which the Distribution of the Track resides, depending upon the number of servers, network communication time and errors, and so forth. The caller may choose whether or not to wait for the request to reach, and be accepted by, all servers. If it is chosen not to wait, then it is not possible for the Script to check back later in order to find out the eventual disposition of the request.

The return value is a "struct" -- an object with properties (fields) with certain names.

• "requestStatus" (String) -- An indicator as to whether the request has been completely accepted or not. Will be either "Pending" or "Completed".
• "requestNumber" (Number) -- An integer number is assigned to every ramp adjustment request, whther made by the user or from a Script. This number appears in events and error messages in the Result for identification purposes.
• "resultText" (String) -- If the request has completed, this contains multi-line text and messages describing what happened. This field will be empty if the request is still "pending".

Here is an example Script that changes the current Distribution of the current Track to hold at the current level of virtual users. It waits until the adjustment is accepted and then outputs information about the request to the Result.

 
 var out = $context.currentTrack.currentDistributionRampHold(null);
 
 var details = "requestStatus=" + out.requestStatus + "\n";
 details += "requestNumber=" + out.requestNumber + "\n";
 details += "resultText=" + out.resultText + "\n";
 
 $context.result.postMessage($context.result.LEVEL_INFO, "Disposition of ramp request", details);

"Ramp" is defined as Track parallel repeating with a "start interval" and/or "end interval". The use of parallel repeat renewal is required for ramp adjustments to work properly.

This method may be called at any time, including when the ramp is paused or pausing, or when it is already resuming.

This method institutes the new ramping request, but does not wait for the specified ramping goal to actually be reached, as that might occur much later.

For multi-server Compositions, the request may take some time before it is accepted by all of the servers on which the Distribution of the Track resides, depending upon the number of servers, network communication time and errors, and so forth. The caller may choose whether or not to wait for the request to reach, and be accepted by, all servers. If it is chosen not to wait, then it is not possible for the Script to check back later in order to find out the eventual disposition of the request.

The return value is a "struct" -- an object with properties (fields) with certain names.

• "requestStatus" (String) -- An indicator as to whether the request has been completely accepted or not. Will be either "Pending" or "Completed".
• "requestNumber" (Number) -- An integer number is assigned to every ramp adjustment request, whther made by the user or from a Script. This number appears in events and error messages in the Result for identification purposes.
• "resultText" (String) -- If the request has completed, this contains multi-line text and messages describing what happened. This field will be empty if the request is still "pending".

Here is an example Script that changes the current Distribution of the current Track to ramp to 400 users over 5 minutes. It waits until the adjustment is accepted and then outputs information about the request to the Result.

 
 var out = $context.currentTrack.currentDistributionRampTo(null, 400, 300000);
 
 var details = "requestStatus=" + out.requestStatus + "\n";
 details += "requestNumber=" + out.requestNumber + "\n";
 details += "resultText=" + out.resultText + "\n";
 
 $context.result.postMessage($context.result.LEVEL_INFO, "Disposition of ramp request", details);

Any existing instances of the Track that have already started will be allowed to finish normally.

The prohibition on new instances of the Track takes effect as soon as the call is made. Once the prohibition is in effect, it cannot be cancelled.

If the Track has been copied to multiple servers (for example by entering a value into the "Copy Count" field when "Dedicated Load Server" is selected in the "General" tab in the Composition Editor), this call will only affect instances of the Track on the individual server on which the current Track is playing. It will not affect copies of the Track that are playing on other servers.

The stop will occur immediately once the calling Script ends.

Wherever this call is made within the Track hierarchy, all items in the current instance of the Track will be stopped. For example, the Clip containing the current Script will be stopped, no further items in the Clip will play and no new Clips will be started in the current Track instance.

The stop will occur for the current instance of the Track once the calling Script ends. The stop will occur immediately during the call for all other instances of the Track.

All instances of the Track will be stopped and no further items will play. For example, containing Clips will be stopped, no further items in the Clip will play and no new Clips will be started.

If the Track has been copied to multiple servers (for example by entering a value into the "Copy Count" field when "Dedicated Load Server" is selected in the "General" tab in the Composition Editor), this call will only affect instances of the Track on the individual server on which the current Track is playing. It will not affect copies of the Track that are playing on other servers.