You are here: Reference > Rule types > Extracts > Extract rules - Completing Filter Criteria tab

Extract rules
Completing the Filter Criteria tab

  1. About 
  2. New 
  3. Definition 
  4. Filter Criteria 
  5. File Specification 
  6. Execution History 
  1. History 
  2. More... 

Complete the Filter Criteria tab to extract values:

The following table details how to use the fields listed in the Criteria array.

Field

Description

Use Last Updated Time as Start

For classes that include the property pxCommitDateTime, select this check box to extract all data that was created or updated since the last time the Extract rule was run. This field is not relevant until the Extract rule has run at least once.

Note: If you select the incremental extraction option, a filter condition is automatically included during an extract that restricts extraction to class instances where the pxCommitDateTime property value is greater than or equal to the last date and time when the extract ran. pxCommitDateTime is automatically set for each class instance when it is changed in the database by the Pega 7 Platform database regardless of how the data was created or changed (interactively by an end user, programmatically by an activity, through an import, or by any other means). This condition is added to any others you specify on this tab.

Sometimes the pxCommitDateTime property may need to be added as a database column to the class table. For example, it is not added automatically on upgrades. An extract using the incremental extraction property will fail if this column does not exist in the class table. Also note that when incremental extraction is performed, class instances with NULL values of the pxCommitDateTime property will be skipped and when using the -c command line option to extract from child classes, those child classes whose class tables do not include the pxCommitDateTime property will be skipped.

Do not select this check box if you plan to run the Extract rule using the command-line and intend to use the -d, -D, -u, and -U parameters. This is because these parameters do not override the check box setting , which can result in unanticipated results from a command-line extract.

Logic

Based on the Label values in the Criteria array, enter a logical expression that defines how the system combines the criteria into an overall Boolean value at runtime. The expression can include parentheses and the operators "AND" and "OR".

For example, if the table contains four rows labeled A, B, C, and D, you can enter logic such as:

(A OR B OR C) AND D.

Notation for this field is similar to the logic statement in When condition rules.

If you create a logic statement, it must include all labeled rows. If you do not include a logic statement, the system selects data instances for which all logic rows return the value True.

Note: You must include at least one logical expression in the Criteria array.

Label

Optional. An entry in this field is used in the Logic field. The entry must:

  • Be unique
  • Start with a letter
  • Have only alphanumeric characters
  • Have no spaces

If you enter multiple criteria, enter a letter or letters to uniquely identify the row. For instance, if you have three rows, their labels can be A, B, and C.

Field

Enter a property reference to provide the filter values. You can only use properties exposed as individual columns. Start the property reference with a period.

Click Edit to the right of the field to create a new property.

Note: Do not use properties of type TextEncrypted.

Operator

Select a comparison condition, such as Is Equal or Starts With.

At runtime, BIX converts the operator comparison condition to a standard SQL comparison statement.

Note: Non-standard operators, such as the Oracle CONTAINS feature, are not available.

Value

Enter or select one of the following comparison values:

  • A literal constant, formatted in accordance with the property type. See Constants in expressions Developer help topic Constants in expressionsfor formatting help.
    Place a backslash character in front of any double-quote character that displays within the constant (\").
  • For a DateTime property, you can specify the symbolic value Last Extraction time. At runtime, this value is replaced with the date and time when the extract rule last ran. You can define a filter using this value as an alternative to checking the Use Last Updated Time as Start option described above, to perform incremental extraction based on any DateTime property you choose.

If the Condition field is set to IS NULL or IS NOT NULL, leave the Value field blank.

About Extract rules