Skip to main content

 –

Creating and running an Extract: Filter Criteria

Suggest edit Updated on August 16, 2021

Use the Business Intelligence Exchange (BIX) Filter Criteria tab on the BIX ruleform to select filter conditions for properties of the primary class and on the clipboard at runtime.

  1. In Criteria, specify the following filter information:
    Criteria filterDescription
    Use last updated time as startThe default symbolic reference filter Last Extraction Time, pxUpdateDateTime, functionally replaces the pxCommitDateTime property to enable incremental extractions. It is recommended to clear Use last updated time as start and rely on the default symbolic reference pxUpdateDateTime in the filter criteria.Select for incremental extractions in order to limit extracted data to properties that contain an updated pxCommitDateTime instance when compared to the last extraction. You must configure incremental extractions using classes that contain the property pxCommitDateTime.
    Skip standard filtersSelect to exclude the primary key column (pzInskey /pxObjClass) from the filter during extraction. For more information about the database table primary key, see Database table primary key (handle).
    Skip standard order by clauseSelect to exclude default sorting based on the primary key column (pzInskey /pxObjClass) for the extraction.
  2. In Filter conditions to apply, define the filter criteria by referencing the labels of the rows below and applying the SQL operators AND, OR, and parentheses. For example, if there are four filters labeled A, B, C, and D, you can enter the following logical expression: "(A OR B OR C) AND D".
  3. Optional: The default field pxUpdateDateTime enables incremental extractions in order to limit extracted data to properties that contain an updated pxUpdateDateTime instance when compared to the last extraction.

    Delete this field to run use manual extractions.

  4. In the filter table, click +Add filter add a row and enter the appropriate filter information:
    FieldDescription
    LabelEnter an alphanumeric label for the filter. Do not include spaces in the label.
    FieldEnter a property from the referenced class. Properties must begin with a period. When entering a property, a list of potential property matches appears. Select Best Bet to see the closest matching-property entered string. Select All Matches to see matching properties that contain the string you entered.

    Example: .pxObjClass

    Calculation Builder (icon)Click the icon and select an available SQL function call, literal value, or property name. For details, see The Calculation Builder.
    OperatorSelect a logical operator for the comparison condition, such as Is equal or Starts with.
    ValueEnter a value for a property that exists in the class or that you created in the Parameters or Pages & Classes tab to run against the field and operator. When you enter a property value, a list of potential value matches appears. Select Best Bet to see the closest matching property matches to the entered value. Select All Matches to see matching values for the alphanumeric value that you entered.

    Values to run against the operator include the following:

    Example Values
    A parameter defined in the Parameters tab present in the clipboard at runtime. For example, .Param.RunDateTime.
    A page & class defined in the Pages & Classes tab present in the clipboard at runtime. For example, .AnotherPage.pyLabel.
    A constant type. For more information, see Constants in expressions.
    A symbolic date relative to the time of extraction, such as Yesterday or Current Year. For more information, see Evaluation of symbolic dates.
    A calculation. Click the Calculation Builder icon to the right of the value field to use a SQL aggregate function to run against the operator.

    Use null if emptySelect to replace empty Value fields with a null value to ensure extract files do not contain empty values.
    Ignore CaseSelect to ignore lowercase and uppercase in the Field and Value of the filter.
  5. Click Save to apply this filter criteria.
  6. Return to Creating and running an Extract rule to continue creating an Extract rule.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us