Property Groups

Prev Next

Overview

The property group feature allows you to group several properties together for redundancy or synchronization purposes. To add new property groups, click the Automation > Property Groups link on the navigation bar:

The list shows each group's Name, Group Type, Group Value, Master Value and Group State. Click edit to change a group, the trash icon to delete it, and Add + to create one. A group that is blocked by Block Execution is shown in red.

There are three types of property groups: Redundancy, Synchronization, and SynchronizationMaster. Each can also be built from whole objects rather than single properties; see Object Based Property Groups.

Redundancy Groups

Redundancy groups are used for properties that should usually be in sync and are therefore redundant to protect against device failures. For example, you could wire up a device to the same GPI pins on two different xNodes. In normal situations, both nodes would be tripped and Pathfinder would see two nearly simultaneous closures. An "Or" logic flow could be created to trip on whichever one came in. But without some complex logic, inbound signals could be processed twice. Property groups build intelligence into this using a combination of timing logic and (where possible) message IDs to create a redundant path but process only one of the two messages if both are received. An example might look like this:

In this situation, the output of the PropertyGroup inherits the syntax of the input properties, which is supplied to the logic flow editor. The property group handles the logic of understanding whether a new closure is the redundant closure to one on the opposing xNode or a new closure that needs to be processed. The PropertyGroup then outputs only unique signals. The logic flow can then handle the actual functionality without worrying about the redundancy aspect of the signals.

Creating a Redundancy Property Group

To create a Redundancy Property Group, click Add +:

Give the property group a name and select Redundancy from the drop-down list. Case sensitivity determines whether values that are the same except for case should be considered equivalent. For example, in our GPIO example, case sensitivity plays a role in whether H is the same as h. The pending interval is the amount of time that an event will stay in the pending state waiting for the recursive event from the other device before being removed. This does not pause the execution of the event, but if the duplicate event from the other device never comes, eventually we should stop waiting for it. If the duplicate event does come, then we clear the pending state but do not indicate the change since it has already been indicated.

Next, click Add + to add the GPI pin state property to the group. This opens a dialog where you can configure several properties:

Only the signal property is required. The other two are used for very specific use cases where a group of properties are obtained at once and need to be evaluated only when the trigger property is set or when there is additional id information available that the system can use to identify unique events. In this case, set the Signal property to the GPI pin state property of xNode A by clicking the ellipsis button next to the signal property and selecting the Gpio pin. Leave the Id and Trigger properties blank. After selecting this pin state property, click Apply, and the new property will be added to the group. Then repeat the procedure with the pin from xNode B. The result will look something like this:

We have now told the group to expect a pin closure from two different xNodes and to treat them as one signal. The pending interval helps with the underlying logic to track unique cues versus redundantly received cues. Applying the changes to this property group will create the new group in the property groups list.

The screen also shows the current value of the property and whether the property from each of the hosts is in sync or out of sync. Out of sync means signals have been received from one device that have not been received from the other.

Once this property group has been created, it can be used as the start point to a logic flow by setting the start point to the GroupValue property of the property group.

This logic flow will set GPO port 4 pin 4 based on a GPIO closure, except that the GPIO closure is fed via redundant sources in case of an xNode outage.

This can be extended beyond GPIOs to any other property in the system. For example, you could set up redundant device emulator paths and pair the resulting watchers from both emulators into a property group.

The output of a property group could also be applied to a Sap Property router. The example below groups some device-specific metadata and sending that information into a Sap Property router for distribution to automation systems:

You can also use the group state property of the property group to detect broken redundancy: use a delay in a logic flow so that an alarm is raised if the property group remains out of sync for more than a certain amount of time.

Synchronization Groups

Whereas a redundancy property group pairs redundant incoming signals, a synchronization group attempts to keep groups of properties in sync. For example, you could group two GPO pins together, and whenever any one of the pins in the group changes, that same state would be pushed to all other pins in the group. This could also be accomplished via a logic flow, but this option simplifies the logical combinations when you are trying to keep multiple properties in sync.

Creating a Synchronization Property Group

To create a Synchronization Property Group, from the Property Groups view, click Add + and select Synchronization as the type. Give the group a name.

Click Add + to add a property. In this case, only the property selector dialog opens.

Add the properties you want to synchronize to the group.

In the example above, changing any pin on this port changes all of the pins to that state. Click Apply to apply the changes.

This example could also be extended beyond GPIO pins. For example, it could be used to keep VMIX On/Off states in sync between mix engines. You can also use the GroupState property with a delay in a logic flow to alert an administrator about states that remain out of sync for a period of time.

Synchronization Master Groups

The differences between Synchronization Group and Synchronization Master are subtle but important in determining which is appropriate.

Synchronization Group attempts to keep items in sync by using the last change to any item in the group. When one item is changed, the others are sent commands to change to the same value. If a device reboots and comes back in a state that is different from the group, the new state is the most recent and therefore would be used. However, this also means that a manual change on one item in the group is automatically sent to all other items in the group.

Synchronization Master, on the other hand, has a property called MasterValue. Setting that MasterValue property to a certain value will send the value to all items in the group. If one of the items in the group is changed manually or by a reboot, there are two possibilities, depending on the Allow Out Of Sync property. If Allow Out Of Sync is true, the group's state is set to "out of sync" and no other action will take place. In that case, you can build your own logic to decide what action should be taken. If the Allow Out Of Sync property is false, then a command will be sent to try to force the item back into synchronization. Any time an item in the group changes its value away from whatever is defined in MasterValue, an attempt will be made to force it back if the Allow Out Of Sync property is false.

<NoChange>

The one exception to the rules above is if the MasterValue is set to <NoChange>. In that case, the items in the group can behave independently again until an actual value is set in the MasterValue again. The state will still show whether the items are in sync or out of sync, but this can be used to disable the enforcement of master value when necessary. The MasterValue is not retained between restarts of Pathfinder Core PRO. By default, when a SynchronizationMaster group is first started, the MasterValue will be set to <NoChange>. To retain the value between restarts, use a memory slot with the StartupState set to LastKnown and a logic flow that hooks the memory slot to the MasterValue property. Then you can change the MasterValue property by changing the memory slot, and the value will get reset when Pathfinder Core PRO restarts.

Force Sync Retry

When Allow Out Of Sync is False, a Force Sync Retry setting (in milliseconds) appears. The example below keeps pins 2 to 4 of GPO port 2 at the Master Value h. When an item is out of sync, the group sends the master value immediately, and then sends it again at this interval until the item reports the correct value. This covers a device that goes offline and comes back in the wrong state.

Because the Group Value has no meaning for a SynchronizationMaster group, the Property Groups list leaves it blank. Watch the Master Value and Group State instead.

Nothing stops two competing authoritative configurations, such as two SynchronizationMaster groups or a group and an authoritative Scene, from setting the same property to different values. They will fight, switching it back and forth rapidly and loading the CPU of both the device and Pathfinder Core PRO.

Other Group Settings

Setting

Description

Disabled

Set to True to stop the group from working. Its state shows Disabled Group.

Case Sensitive

Whether values that differ only in case, such as H and h, count as different.

Pending Interval

How long, in milliseconds, the group waits for related changes before deciding its state.

Execution Limit

The recursion limit for the group, as for logic flow translators. Default 50/1000.

Each item in a group also has a Disabled value. Click it to switch it between False and True, then click Apply. A disabled item is left out of the group: a Redundancy group ignores it when working out its state, and a Synchronization group stops updating it.

Disabled is also a property of each group and of each item, so you can set it from a Logic Flow or over SapV2 as well. In the Logic Flow property selector, select API and choose Disabled under the group or the item in PropertyGroups.

When synchronizing a router destination's CurrentSourcePath, an empty value and :// (nothing routed) are treated as the same.

Object Based Property Groups

An object-based group applies a group to every matching property of several objects at once. For example, instead of building a Synchronization group for each pin of two GPO ports, you can build one object group for the two ports, and Pathfinder Core PRO creates a group for each pin.

  1. Click Add +, give the group a name, set Type to ObjectGroup, and choose the Object Group Type: Redundancy, Synchronization or SynchronizationMaster.

  2. Under Object Group Paths, click Add + and choose an object (not a property) in the Property Selector. Add each object you want in the group. The objects must be of compatible types, such as two GPO ports.

  3. Under Object Group Properties, click Add +. The Object Property Selector lists the properties the chosen objects share. Select the properties to group, set an Execution Limit if needed, and click Add.

  1. Click Apply.

Edit the group again and click View Subgroups to see the groups that were created, one for each matching property, with their values and states:

Click View on a subgroup to see its items: