Setting Property Paths

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

Properties, property paths, and In Situ Substitution Expressions (ISSEs) are presented as blue rounded boxes throughout CloudTest. They are displayed as “bubbles” also in the lower panel. There is a new, lower-panel Expert button that allows users to expand the bubble to toggle between full text and bubble view). Simply double-click or hover (single-click) to inspect or edit their data and info. Double-click any property box to open it in its appropriate editor.

Placed properties appear as rounded blue boxes throughout the CloudTest user interface making them easier to find later. For example, the Clip Editor, List View, Parameter 2 column shown right has a property, username, placed into its Query String.

Property boxes also appear where Property entry fields exist, such as in expanded If-Then-Else or Switch containers shown in the Clip Editor List or Icon View.

Property boxes are also displayed in the Composition Editor whenever a property field or value is in display. For example, whenever a Repeat By Property repeat method is specified for either a track or clip repeat. When Repeat By Property is first selected from the Repeat Method drop-down, it will display [not specified] until its value is specified via the Property Chooser.

For more complex ISSEs, user-friendly display means hiding the underlying ISSE syntax in favor of a clickable, and more readable format as shown in the Group 1 container below, where a user-friendly ISSE is deployed.

A closer view shows that the user-friendly version of this expression has the same rounded-blue border as the other items above.

To inspect the full expression syntax for any user-friendly ISSE, double click to inspect it in the lower panel. Note that the Locator field on the right shows the concatenated expression.

To show the full ISSE, toggle the Expert button to the right of the field where the ISSE has been entered.

About Paths in CloudTest

Property paths in CloudTest are similar to those found in most operating systems. They are set by specifying the starting element. The “root” or “starting point” of the path is specified (e.g. the item to which the path is relative). Additionally, both of the following conventions can be used to define relative paths: “.” and “..” .

For example, the path  {%% prop: Message: Message5/msgprop %%} specifies the property “msgprop” in the Message “Message 5”, which was assumed to be in the same container as the current Message. The “Message:” in the middle field specified that a Message’s property was to be found.

In current paths, the middle field specifies the starting point of the path. The obsolete path above can be written as either:

{%% prop: Message: ../Message5/msgprop %%}


{%% prop: Clip: Message5/msgprop %%}

This second path is made relative to the current Clip by specifying “Clip:” for the middle field. The second example assumes that the Messages are in a Clip, and not a Chain, otherwise “Chain:” is used for the middle field of the ISSE to specify that the path is relative to the current Chain).

The vast majority of ISSEs and property paths entered probably don’t specify any path currently, and those remain unchanged. For example, the following existing path:

{%% prop: Clip: myprop %%}

The path above specifies that the property “myprop” of the current Clip still works the same in this release and does not need to be changed.

The areas affected by this change are:

  • Path syntax.
  • The Scripting method “getItemViaPath” for all item types.
  • The Scripting objects $prop and $sysprop.
  • A “property path” entered for a repeat that involves a property.

Property repeats are specified in the repeats for Tracks or Clips whenever the repeat involves a property (“Repeat By Property”, “PFor Each”, or “While”).

  • Anywhere in the Clip Editor where the “Property Chooser” dialog is used and a custom property path is entered into the edit control at the bottom.  

For example, a path for PropSets is shown on the right.

Similarly, in the Message Editor, Property Sets form on the right, the Starting Element is specified from among: Composition, Current Band, Current Track, Current Clip, Current Target, Current Destination, Current Chain, or Current Message.

Based on the specification, the property path field can take a relative path. For example, the following are all equivalent to set one of the current Message's properties, assuming that the property path field’s value is being set from "Message4" in "Clip7":

Starting point, path
Message, propname
Message, ../Message4/propname
Clip, Message4/propname
Track, Clip7/Message4/propname

For a more interesting example, to set a property of "Clip7", which you happen to know is in the same Track as the Clip containing this Message, the following are all equivalent:

Starting point, path
Track, Clip7/propname
Clip, ../Clip7/propname
Message, ../../Clip7/propname