Setting Repeats On Tracks and Test Clips

Document created by Chris Sommerstad Employee on Jul 21, 2017
Version 1Show Document
  • View in full screen mode

Track repeats can be Repeat By - Parallel, Repeat By – Serial, Repeat By, For Each, While, Infinite, or None. A Infinite, or infinite, track repeat will play infinitely until the test composition is stopped. Default repeat states vary by band timing. The default sequenced band uses None as the default repeat (note that the icon that appears in this state is the Virtual Users icon covered in the following section).

Clicking the repeats area once will change the repeat state to Repeat By – Parallel.

When the sequenced band is changed to a timed band, clicking the Virtual Users icon produces some additional options: None, Repeat By (Parallel), Repeat By (Serial), and Infinite appear consecutively. All repeat types can be set for both band timing types using the lower panel.

Note: Band timing can only be changed when no clips have been added to a test composition.

Defining Virtual Users on Tracks

The repeat count, or virtual users, can be set on the surface of tracks using the Virtual Users icon to toggle an entry field on the track. The Total Virtual Users figure at the top of the column is an estimation.

To define virtual users on a track in a test composition, click the Virtual Users icon and enter the number of Virtual Users for the track.

When track repeats are revised, the same Repeat By value(s) in the Composition Properties for the given track are changed.

Track duplication results in an automatic per-cent distribution of virtual users across those tracks.

The percentage of distribution per track can be manually edited by clicking into the Location Percentage field. When the cursor is in the field, or when the cursor hovers over this field, an informational pop-up appears showing the prior value. A manual edit of a percentage results in the difference being added, or subtracted, from Track 1.

Allocate Virtual Users to Track Using Percentages

Additionally, virtual users can be allocated to a track using a percentage of a total number.

  1. Open or create a multi-track composition. Note that the number of virtual users matches the number of tracks (1 VU per track).

  1. In Track 1 of a multi-track composition, enter the total number of virtual users desired as an integer. Note that the original percentages change as shown below.

  1. For each track enter a percentage. The total percentage for the other tracks is updated along with this change. If the total virtual users desired are a set number, it is also possible to physically enter the number per track (e.g. instead of entering 1000 for track 1 and then entering percentages for other tracks, you can enter an integer for each track).

Setting Track Repeats on the Track’s Surface (Timed Band)

For the default sequenced band, track surface settings toggle between None and Repeat By – Parallel. For tracks on timed bands use the following instructions to set surface repeats.

  1. For a track on a timed band, click the repeat area to toggle through the available surface repeats.
  2. When you do so repeats will cycle through the following options: None, Repeat By – Parallel (the parallel icon shows), Repeat By – Serial (the serial icon shows), and Infinite, which appears as [infinite] (shown right).

Note: Repeat By, For Each, and While options cannot be set via the track surface but they can be set via the lower panel Properties tab > General tab.

Setting Track Repeats from the Repeat tab

The following instructions can be used for both Sequenced and Timed band timing types.

  1. Click the Properties tab in the Composition Editor, or, double click the track to open the Properties > General tab.
  2. In the Repeat Type list, choose from among None, Repeat By - Parallel, Repeat By – Serial Repeat By, For Each, While, and Infinite.

Repeat By, For Each, and While each require a value be set via the Property Chooser dialog box.

Additionally, each of these types permits the user to specify a repeat timing type (parallel or serial).

When parallel is set the Renew Parallel Repeats field is also available. Check this option to replace each virtual user with a new virtual user (parallel repeat) as it ends. Using this checkbox causes the count of parallel repeats to remain the same. Unchecking this box (as shown) will allow the virtual user to expire when it has finished playing.

With Renew Parallel Repeats checked, the active tracks will always be the number in order to generate the specified load. See Renew Parallel Repeats for more about this setting.

When parallel is set the Repeat tab also displays a Start Interval field that permits an optional start interval to be set to regulate the time between repeats.

  1. Save the test composition after making any changes.

When Repeat By and serial repeat timing are set the track surface indicates the integer value of [x] alongside the Serial icon:

If the default serial repeat timing is changed to parallel the icon appears as below.

When For Each is set the track surface indicates [for each].

If the default serial repeat timing is changed to parallel the icon appears as below.

When While is set the track surface indicates [while].

If the default serial repeat timing is changed to parallel the icon appears as below.

Defining Repeats on Test Clips

Repeat count can be set on the surface of test clips in the Composition Editor using the Repeat Count toggle button. When you do so repeats will cycle through the options: None, Repeat By (Serial), and Infinite, which appears as [infinite] on the clip surface.

For Repeat By repeats, click the button on the test clip and then specify a value in the text field that appears, and then click again outside the repeats area to exit the toggle. Repeats set on the surface of either tracks or test clips are "Repeat By" repeats without a property value. To specify a "Repeat By" value conditionally, use Repeat By.

Additionally, repeat count can be set for the test clip using Composition Editor properties. Select the test clip whose repeat count you want to change by single-clicking it. Select the Properties tab in the lower panel of the Composition Editor. You will then see the Repeat Count field. Update the values and click Enter to make the changes.

Serial vs. Parallel Repeats on Test Clips (in Timed Compositions)

 

In Timed Compositions, Repeat By - parallel, Repeat By - serial, and Infinite repeats can be set using the Repeat Count toggle icon on the surface of test clips in the Composition Editor. Simply click the icon in your Timed Composition to cycle through the options: parallel, serial, or inactive. Note that for longer timed clips the Repeat Types icon may appear on the far right of the clip. If necessary, scroll to locate this icon.

 

  • Use Repeat By - serial repeats to fire the test clip sequentially, or serially, at the specified time for the repeat count indicated by the integer on the test clip surface.

  • Use Repeat By - parallel repeats to fire the test clip concurrently, or in parallel, at the specified time for the same integer.

  • Use None to fire the test clip only once.

  • Use infinite, or Infinite, to fire the test clip until the test composition stops playing.

In the screenshot on the right, the test clip in Track 1 will repeat 2 times in serial. In Track 2, the clips will fire in parallel for the specified integer.

Setting Infinite Repeats on the Clip’s Surface (Sequenced Band):

  1. For a clip in a track that resides on a sequenced band, click the repeat area on the clip’s surface.

When you do so repeats will cycle through the options, : None, Repeat By (Serial), and Infinite, which appears as [infinite] on the clip surface.

  1. When [infinite] appears, save the test composition.

Setting Infinite Repeats from the Repeat tab

  1. Click the Properties tab in the Composition Editor.
  2. Select the test clip to repeat in the Properties list. Alternately, double click the test clip in the workspace to pre-select it in the list below.
  3. In the Repeat tab, set the type to Infinite.

Note that when Infinite is selected, the clip’s surface indicates [infinite]. Any integer repeats that were previously specified become inactive but are not removed.

Repeats: For each, While, and By Property can be set from the Repeat tab in the lower panel.

Repeats can employ properties that use For each, While, and “By Property” logic to insert values into tracks, test clips, and messages at runtime.

You can specify any type of property for use with repeats: Custom, System, or Global, although custom properties will probably be most commonly used.

For Each

  • A For each repeat works when the property value is an array.

A property’s value can be set to an array from a script, or by the use of a Property Set created from a message response. A property can take on an array value when it has a response that matches more than one value. Property Sets can be created for existing properties in the Message Editor, Results tab.

While

  • A While repeats as long as the property’s value evaluates to “true”. The current value of the property is converted to a Boolean each time through the repeat. Therefore, the value must be changed to false inside the repeat to stop it (unless an infinite repeat is desired, as in the case of a Composition that will run until stopped).

Note: The While option can only be used with the Serial repeat timing type. Tracks cannot repeat serially therefore the While value does not appear for track properties.

Conversion to Boolean follows these rules:

  • Null: Null is false.
  • String: “true” (case insensitive) is true, everything else is false.
  • Numeric values: zero is false, everything else is true.
  • Values of type date, array, or struct are invalid, and will result in an error.

To define repeat properties on a track or test clip using Repeat By, For Each, or While)

The following instructions detail how to set For each, While, or Repeat By (By Property) on a test clip or track.

  1. Select the track or test clip.
  2. Right-click the Repeat icon and then select Edit Properties.

In either case, the test composition’s Properties tab is selected in the sub-pane below with the track or clip selected in the Properties list and the Repeat tab selected on the right.

Note:  Custom Properties can be defined for the track or clip while it is selected in the Properties list by clicking the Custom Properties tab in the sub-pane. To set clip properties, return to the Clip Editor and use the Properties tab > Clip Custom Properties node in the properties list.

Once the Repeat Type is selected, click the Property Chooser icon to specify the path for the given property. When you do so the Property Chooser dialog appears for you to make your selection.

Attachments

    Outcomes