Manual Redirection using a Property Set

Document created by Chris Sommerstad Employee on Jul 21, 2017Last modified by Dave Murphy on Oct 11, 2017
Version 2Show Document
  • View in full screen mode

The Before and After Property Sets tabs allow the value of any Custom or System Properties to be set before or after a given container or nested clip. In the Clip Editor, the Property Sets Before and Property Sets After tabs appear in the lower panel whenever a container or nested clip is open in the Clip Editor lower panel.

For any container in the Clip, such as a Group, Transaction, or nested Clip, the Before and After Property Sets tabs allow you to set the value of any Custom or System Properties before and after play of that container. This allows you to control or change the behavior of the container, or receive output values from the container.

 

Pass & Return Values from a Container

Using Property Sets Before and After is analogous to passing parameters to, and returning values from, a function, where the container is the “function”.

    • The Property Sets Before tab allows you to pass values into the container by setting some of its Custom and/or System Properties. This is analogous to the “input” parameters of a function.
    • The Property Sets After tab allows you to extract values from any of the container’s Custom or System Properties and place them into some other properties. This is analogous to the “output” parameters and/or “return value” of a function.

A common case uses a nested Clip from inside of another Clip. The nested Clip can be considered as a “function”, and the containing Clip can be considered as the “caller”. The container wishes to pass values into the nested Clip to alter its behavior, and the nested Clip wishes to return values back to its caller.

When you design a Clip with the intent that it will be nested inside of other Clips, you might want to design the Custom Properties of your nested Clip with this feature in mind. Consider any behavior that the user of the nested Clip might need to alter, and create a Custom Property that the user of the nested Clip can set to cause that alteration. In addition, consider any output information that the user of the nested Clip might want, and arrange to place such information into Custom Properties during the play of the Clip. You might even consider adopting a naming standard for the Custom Properties of your Clips so that users of the Clips know what the Custom Properties are for, and which ones are “inputs” and which ones are “outputs”.

For further steps, see Setting a Container Property Value before Play and Extracting Property Values from a Container after Play.

Property Sets Before

  • Use Property Sets Before when the value of a property must be set before the container plays.

For the tab on the right, the Object Properties section shows custom properties within the selection (e.g. within the nested clip, Selected: Login). The Selected: Loginnested clip has three custom properties. Use the Property Sets Before tab to set the values of any of these properties.

 

Property Sets After

  • Use Property Sets After when the value of a property must be set after the container plays. In the Selected: Login nested clip on the right wpLoginToken is an extracted token value set by the user authentication and is to be passed back out of the container for later use elsewhere.

 

The Property Sets Before and Property Sets After tabs are divided into two lists. The top list is prepopulated with the Custom Properties that exist directly in the container. This is for convenience, as these are the properties that are most often used for these purposes.

However, any Custom or System Property anywhere within the container and it’s children at an level may be used. This can be done in the bottom list by specifying a path to the property of interest.

 

 

Value Type Icons in the Property Set Tab(s)

Each row in each list contains a Value Type icon:

  • Constant icon - Constant icon

Indicates that the property is being set to a constant.

  • Custom Property icon - Custom Property icon

Indicates a Custom Property is being set, or that a property is being set to a Custom Property.

  • System Property icon - System Property icon

Indicates a Custom Property is being set, or that a property is being set to a Custom Property.

 

Using the Other Property Sets list

The Other Property Sets list is used to set a property not directly owned by the container. For example, a property in one of the children of the container.

  1. Open the Property Sets Before tab for the container.

 

 

  1. In the Other Property Sets list, click the Browse icon. The Path dialog box appears.
  2. Locate the target or clip element where the property is located and then click the Custom tab.

  1. Click OK. The selected property is inserted into the Other Property Sets list.
  2. Once the property is shown in the Other Property Sets list, an override constant value or other property path can be inserted by either clicking the Browse icon—this time using the Browse icon for the Path field—or an override constant value can be entered.
  3. Save the clip after making any changes.

Setting a System Property in a Container

  1. In the Clip Editor, open the Property Sets Before or Property Sets After tab for the container.
  2. If the property is already listed in Other Property Sets, and an override value will be used, enter that constant value (shown below).
    • If the property is listed and it will be set from another property, click the Browse icon.

      • If the property is not listed, click the Browse icon.

Locate the system property whose value will be set.

  1. Click OK. The path to the System Property is inserted into the Path field.
  2. Enter the constant or the path to the other property, according to how the property’s value is to be set.
  3. Save the clip after making any changes.

Attachments

    Outcomes