Sorting plan data

Use the Sort window to sort atomic properties or persisted calculated properties in a Plan Data plansheet. This window is displayed by selecting the Sort option, which can be accessed when you right-click the column header of a plansheet. Alternatively, a default sort can be defined in the plansheet configuration. See, Default sorting for Plan Data plansheet.

The format of the Sort Label is determined by the sort parameters. These are the possible scenarios:

  • The sort period and property are displayed based on the display settings of a user. For example, when periods are in the slicer panel, the period is displayed as description to align with the period slicer display.
  • The ‘’Top {0}’’ label is displayed only if the rv_top_results sort type is selected, or a value is specified in the Sort window.
  • If the application variables are used, the variables are replaced with the actual values.
Note: The Sort option is not displayed if:
  • The property and periods are not available in the table header or the slicer.
  • Resources are not displayed in rows.
  • The property related to the column is not an atomic property or persisted calculated property.
  • A persisted calculated property is not saved.
  • The period related to the column is not an actual period.

The Sort window is pre-populated based on the context of the selected column. For example:

  • If Sort is applied to the selected column, the Sort window is populated with the current sort options.
  • If Sort is not applied to the selected column, the period and property values of the selected column are displayed. In this scenario, the Direction field is set to Descending, and the Top Results parameter is set to Off.

Review this information in the Sort window:

Property
The name of the property to which the sort is applied.
Note: 
  • The value is defaulted based on the selected column and cannot be modified.
  • This value is displayed based on the display settings defined for the property. See, Modifying user settings.
Period
The period to which the sort is applied.
Note: 
  • The value is defaulted based on the selected column and cannot be modified.
  • The value is displayed based on the display settings defined for the period.
Order By

The direction in which the sort is applied. Possible values:

  • Ascending
  • Descending
Note: 

If the selected period and property are already used for sorting, the data is displayed based on the existing sort conditions. Else, this value is set to Desc.

Top Results

The number of results that are displayed. If the selected period and property are already used for sorting, the data is displayed based on the existing sort conditions. Else this option is set to Off.

When a new Sort is applied using the Apply option:

  • A check is performed to ensure that persisted calculated properties do not contain edited values when the plansheet is loaded. Else, sorting cannot be applied and this error message is displayed: 
    "Unable to sort calculated property {0} because it is not currently persisted".
    Note: Persisted properties are identified by properties in a workflow that have the Persist Properties: {class}.{propert name} syntax. In standard SCO the persisted properties are controlled by the ‘’210 - Persist Calculated Output Properties’’ and ‘’212 - Persist Calculated Input Properties’’ workflows.
  • The plansheet is reloaded.
  • Modifications to data within the plansheet are not saved.
  • Changes to the data displayed, for example, element browser, pick property and flip headers, are not affected
  • The Sort label is displayed with sort property, period, order type, and top results information.
    Note: If the Top Results parameter is defined, only the first x number of results are displayed in the grid, based on the selected sort options.

This table lists the sort types and related sort label options:

Sort type Label
If the rv_sort_property, rv_sort_period, rv_sort_direction, and rv_top_results parameter is populated or all options selected in the Sort window.

Sorted By: {0}, {1}, Sort Order: {2}, Top Results: {3}

Where:

  • {0} or {1} = sort property or period (displayed based on the defined display settings)
  • {2} = Sort order (Descending or Ascending)
  • {3} = The number of results to display.
Note: Property and period are displayed in the sort label in either position. When periods display in slicer, the period is displayed as period description to align with the period slicer display.

If the rv_sort_period, rv_sort_property, or rv_sort_period, rv_sort_property, and rv_sort_direction parameters are selected in the Sort window.

Note: The rv_sort_direction parameter is not required, because Direction is applied by default.

Sorted By:{0}, {1}, Sort Order: {2}

Where:

  • {0} or {1} = sort property or period (displayed based on the defined display settings)
  • {2} = Sort order (Descending or Ascending)
Note: Property and period are displayed in the sort label in either position. When periods display in slicer, the period is displayed as period description to align with the period slicer display.

You can reset the defined sort criteria using the Reset Sort option. This option can be accessed from the Plansheet menu. Selecting this option resets the sort to the default sort as specified in the plansheet parameters, or to the natural sort order of the data. When you click Reset Sort, the plansheet is re-loaded and the modifications made to the plansheet and the element browser are discarded. Changes to the data displayed, for example, pick property and flip headers, are not affected. The sort label in the plansheet slicer area is updated to display the default sort details. If the default sort is not defined, the Sort Label is not displayed.