Groups > Group Rollups > Filtering a Group Rollup

Filtering a Group Rollup

Important: The following procedures and subsections assume that you have properly configured and built all relevant group hierarchies.

A filter is used to focus on a subset of data points within a rollup. For instance, a rollup might collect information from many meters for a given uniform data code (UDC), but you only want to use information from a subset of those meters. A filter enables you to focus on that subset.

Filters are inclusive, which means that they include only facilities that meet filter criteria, not those that do not meet filter criteria. They are based on one or more facility attribute values or group node attribute values.

Define filters using the General Data Fields located on the Application page of the relevant rollup HyperPoint in the Point Service (PNT). Short filters (20 characters or less) can be defined directly on the Application page, while long filters (more than 20 characters) must reference a group node attribute of the relevant summary group node.

For more information, see the subsections below:

For general information about group rollups, see Group Rollups.

For information about Facility Service (FAC) attributes, see Facility Attributes.

For information about Group Service (GRP) attributes, see Node Category, Type, and Attribute Identifiers.

To Create a Short Filter (20 Characters or Less)

  1. Decide whether your filter will use a facility attribute or a group node attribute, then note the attribute name and its value.

    2. Note: In order to filter by an attribute, you might need to add a new facility attribute and/or value to the relevant facility record or add a new group node attribute and/or value to the relevant group record.

  1. Go to the PNT and open the rollup HyperPoint for the relevant UDC. You do not need to modify the corresponding calculation target point.
  2. Click the Application page and click Edit.
  3. Type the attribute in the General 1 field. Be sure to use the correct syntax. Multiple attributes may be used for stricter filtering by using semicolons to separate the attributes. For instance, you could combine two group node attributes like this: ~attr0=A;~attr1=B.
  4. When you are done, click Save.
  5. Verify success by opening the Universal Interface Service (UIS) where the rollup value is stored and confirm that the reported value is what you expect it to be. If the rollup is a total, the value should be the total of all included point values. If the rollup is an average, the value should be the average of all included point values.

To Create a Long Filter (More Than 20 Characters)

  1. Choose the facility attribute and value by which you want to filter and note them.
  2. Open the Group Manager utility.
    1. Click View, then click As-Built Hierarchies. The Group Service Explorer appears.
    2. If the details pane is not open, click Options and click Show Details.
    3. In the Hierarchy Type drop-down menu of the Group Service Explorer, select Navigation Hierarchies and expand the tree that contains the relevant summary group node.
    4. Select the relevant summary group node, click Options, then click Edit Group Node.
    5. On the node property sheet that appears, click Attributes, then click Edit Node.
    6. Double-click an empty field and type the facility attribute by which you want to filter into the field. Be sure to use the correct syntax. For instance, if you want to filter by facility attribute 2, which has a value of Floyd, you must enter F:facility_attr2=Floyd.
    7. Click Apply then click OK.
  3. Using CygNet Explorer, open the Point Service (PNT) then open the rollup HyperPoint for the relevant UDC. You do not need to modify the corresponding calculation target point.
    1. Click Application, then click Edit.
    2. In the General 3 field, enter the group attribute of the field where you entered the referenced facility attribute from step f above. Be sure to use the correct group attribute syntax; do not include a value. For instance, if the filter facility attribute F:facility_attr2=Floyd is located in the summary group node attribute field ~attr4, type ~attr4 in the General 3 field.
    3. Click Save.
  4. Verify success by opening the Universal Interface Service (UIS) where the rollup value is stored and confirm that the reported value is what you expect it to be. If the rollup is a total, the value should be the total of all included point values. If the rollup is an average, the value should be the average of all included point values.

Facility Attribute-Based Filter Syntax and Parameters

Apply this filter in the General 1 field (if under 20 characters) or General 3 field (if over 20 characters) on the Application page of the relevant rollup HyperPoint property in the PNT Editor.

Syntax

F:facility_attrib=value

Example

F:facility_attr2=Floyd would include only those facilities for which the facility text attribute 2 has the value Floyd.

Parameters
Parameter Definition Options

F:

FAC directory

F:

facility_attrib

Generic facility attribute name

Fac_Info_0, Fac_Info_1, facility_attr0 through facility_attr9, and facility_table0 through facility_table19

value

Attribute value

Any valid value for the specified facility attribute

Note: If the attribute is a table attribute, the value must equal the table entry, not the entry description. For example, F:facility_table1=R1 would filter out all facilities except those for which facility table attribute 1 equals R1 (R1 is the entry; Route 1 is the description).

Group Node Attribute-Based Filter Syntax and Parameters

Apply this filter in the General 1 field (if under 20 characters) or General 3 field (if over 20 characters) on the Application page of the relevant rollup HyperPoint property sheet Point Service (PNT).

Note: If you filter based on a group attribute that is mapped to a facility attribute and you change the facility attribute value, you must rebuild the group to reflect the change.

Syntax

~attrn=value

Example

~attr1=SALESMETER would include only those facilities for which group attribute 1 has the value SALESMETER.

Parameters
Parameter Definition Options

~attrn

Group node attribute ID

Valid options are ~attr0 through ~attr9

At the leaf-node level, some group node attributes are populated automatically with facility attribute values when the group is generated using the Group Service Explorer.

These group node attributes map as follows:

  • Attribute0 (~attr0) = Facility ID
  • Attribute1 (~attr1) = Facility Type
  • Attribute2 (~attr2) = no mapping
  • Attribute3 (~attr3) = Facility Description
  • Attribute4 (~attr4) = Facility Text Attribute 0
  • Attribute5 (~attr5) = Facility Text Attribute 1
  • Attribute6 (~attr6) = Facility Info 0 (Facility Location)
  • Attribute7 (~attr7) = Facility Info 1 (Facility Contact)
  • Attribute8 (~attr8) = no mapping
  • Attribute9 (~attr9) = no mapping

value

Attribute value

Any valid value for the specified attribute

General Data Fields Descriptions

The General Data Fields on the Application page of a point property sheet are used to define filters and references to attributes containing filters. The following table describes the various data fields and their uses.

Note: Filter values cannot contain wildcards. Attribute names and attribute values are not case sensitive.

Field Description

General 1

Use this field to specify a filter definition. You can use facility attributes or group node attributes.

This field is a maximum of 20 characters. Use the field General 3 to reference a Group Service (GRP) attribute if the filter definition exceeds 20 characters.

General 2

Use this field to change the leaf node type of a node that is a child of a summary group node.

By default, filtering is based on leaf nodes that are of the type Facility (~type=~F). This filter option works in conjunction with the General 1 and/or General 3 options.

The only reason a leaf node would not be a facility type is if the group were manually created.

General 3

Use this field to specify a reference to a Group Service (GRP) attribute that contains a facility attribute filter definition. This field is useful a the filter string is too long to fit in the General 1 field.

For example, if the value used in the General 3 field is ~attr8, group node attribute 8 contains the relevant facility attribute filter information. View the group node in the Group Service Explorer.

Group node attributes 4 through 7 allow up to 40 characters. Group node attributes 8 and 9 allow up to 60 characters.
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.