Condition > General Information

• Condition > General Information
  • Introduction
  • IDENTIFIER, SINGLE-LINE-TEXT HTML-TEXT and LONG-TEXT conditions
  • CLASSIFICATION conditions
  • NUMBER conditions
    • Suffixes conditions
  • MULTIPLE-SELECT, MULTIPLE_SELECT_QUANTIFIED, MULTIPLE_SELECT_QUANTIFIED_WITH_COMMENTS or
  • SINGLE-SELECT conditions
    • Quantity conditions
  • IMAGE, ATTACHMENT conditions
  • DATE, DATE-TIME conditions
  • Performing a condition against another value

Introduction

• For a user-facing description of conditions in the Rules Engine (mapping and formulas), see the public guide

• This page focuses on internal details, extended operator matrices and examples that are not exposed in the public documentation.

• The Condition feature set allows us to determine whether an expression is true or false. This tool can be used in the following context:

  • Inside a mapping rule to determine whether a mapping rule should be executed or not
  • Inside a formula to determine whether a rule statement inside a formula should be executed or not
  • Inside a Condition rule, to determine whether a rule should be triggered or not on a specific item

• This document usually mention that a conditions is performed on a specific field. This way of presenting things is inherited from the XML representation of the conditions. If a condition aims to compare a NUMBER field to a value, it will be mentioned in this document that the condition is performed against a NUMBER field. Depending of the operator, the condition may be performed against a static value or against another field.

IDENTIFIER, SINGLE-LINE-TEXT HTML-TEXT and LONG-TEXT conditions

• Examples for those rules may be found here

Available operators:

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
CONTAINS	Contains (not case and accent sensitive)	Mandatory, a single value allowed
EQUALS	Strictly equal (case and accent sensitive)	Mandatory, a single value allowed
STARTS_WITH	Like by (case and accent sensitive)	Mandatory, a single value allowed
ENDS_WITH	Ends with (case and accent sensitive)	Mandatory, a single value allowed
IN	Is equal to one of the mentioned values (a minimum value)	Mandatory, multiple value allowed
NOT_IN	Does not equal any of the mentioned values (a minimum value)	Mandatory, multiple value allowed

Example:

<Conditions>
    <Condition-Group>
        <Condition target="titleEn" operator="STARTS_WITH">
            <Value>Ipod -
            <Value>
        </Condition>
    </Condition-Group>
</Conditions>

#	Identifier / text: a	Identifier / text: b	Identifier / text: ab	Identifier / text: empty / null
EMPTY	0	0	0	1
NOT_EMPTY	1	1	1	0
CONTAINS a	1	0	1	0
CONTAINS b	0	1	1	0
CONTAINS ab	0	0	1	0
CONTAINS c	0	0	0	0
CONTAINS empty	0	0	0	0
EQUALS a	1	0	0	0
EQUALS b	0	1	0	0
EQUALS ab	0	0	1	0
EQUALS c	0	0	0	0
EQUALS empty	0	0	0	1
NOT_EQUALS a	0	1	1	1
NOT_EQUALS b	1	0	1	1
NOT_EQUALS ab	1	1	0	1
NOT_EQUALS c	1	1	1	1
NOT_EQUALS empty	1	1	1	0
STARTS_WITH a	1	0	1	0
STARTS_WITH b	0	1	0	0
STARTS_WITH ab	0	0	1	0
STARTS_WITH c	0	0	0	0
STARTS_WITH empty	0	0	0	0
ENDS_WITH a	1	0	0	0
ENDS_WITH b	0	1	1	0
ENDS_WITH ab	0	0	1	0
ENDS_WITH c	0	0	0	0
ENDS_WITH empty	0	0	0	0
IN [a]	1	0	0	0
IN [a, c]	1	0	0	0
IN [a, b]	1	1	0	0
IN [c]	0	0	0	0
IN empty	0	0	0	0
NOT_IN [a]	0	1	1	1
NOT_IN [a, c]	0	1	1	1
NOT_IN [a, b]	0	0	1	1
NOT_IN [c]	1	1	1	1
NOT_IN empty	1	1	1	1

CLASSIFICATION conditions

• If the specified operator does not exist, or if a parameter is missing, the condition is considered invalid. We add the FORMULAS_RULE_WRONG_FORMAT log in the execution report and the entire rule is not processed.
• In the case of the EQUALS and NOT_EQUALS operators, a single value can be entered. If several values are entered, the condition is considered invalid. We add the FORMULAS_RULE_WRONG_FORMAT log in the execution report and the entire rule is not processed.
• If reference is made to the key of a category that does not exist, the condition is considered invalid. We add the FORMULAS_RULE_WRONG_FORMAT log in the execution report and the entire rule is not processed.
• The maximum number of options in an IN or NOT_IN condition is 1000. If the number of options is greater, the condition is considered invalid. We add the FORMULAS_REACHED_MAX_NUMBER_OF_VALUE_IN_CONDITION log in the execution report and the entire rule is not processed.

Available operators:

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
EQUALS	The value must reference a valid option key.	Mandatory, a single value allowed
NOT_EQUALS	Does not equal the mentioned option. The value must reference a valid option key.	Mandatory, a single value allowed
IN	Is equal to one of the mentioned values (a minimum value)	Mandatory, multiple value allowed
NOT_IN	Does not equal any of the mentioned values (a minimum value)	Mandatory, multiple value allowed

Examples for those rules may be found here

#	Category : ['a']	Category : ['b']	Category : [] / empty / null
EMPTY	0	0	1
NOT_EMPTY	1	1	0
EQUALS a	1	0	0
EQUALS b	0	1	0
EQUALS c	0	0	0
EQUALS empty	0	0	1
NOT_EQUALS a	0	1	1
NOT_EQUALS b	1	0	1
NOT_EQUALS c	1	1	1
NOT_EQUALS empty	1	1	0
IN [a]	1	0	0
IN [b]	0	1	0
IN [a,b]	1	1	0
IN []	0	0	0
IN empty	0	0	0
NOT_IN [a]	0	1	1
NOT_IN [b]	1	0	1
NOT_IN [a, b]	0	0	1
NOT_IN []	1	1	1
NOT_IN empty	1	1	1

NUMBER conditions

• Examples for those rules may be found here

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
LESS_THAN	Strictly inferior	Mandatory, a single value allowed
LESS_THAN_OR_EQUAL	Less than or equal	Mandatory, a single value allowed
GREATER_THAN	Strictly superior	Mandatory, a single value allowed
GREATER_THAN_OR_EQUAL	Greater than or equal	Mandatory, a single value allowed
EQUALS	Strictly equal	Mandatory, a single value allowed

WARNING

The value provided in the condition must be a valid number. If the value provided is not a valid number, the condition will always be falsy and a log will be added to the execution report (ERROR_WHILE_EVALUATING_A_CONDITION).

Example:

<Conditions>
    <Condition-Group>
        <Condition target="price" operator="LESS_THAN">
            <Value>100.4
            <Value>
        </Condition>
    </Condition-Group>
</Conditions>

#	Number = 0	Number = 10	Number = -1	Number is empty (null)	invalid number
EMPTY	0	0	0	1	0
NOT_EMPTY	1	1	1	0	1
EQUALS 0	1	0	0	0	0
EQUALS 1	0	0	0	0	0
EQUALS -1	0	0	1	0	0
EQUALS 10	0	1	0	0	0
EQUALS empty	0	0	0	1	0
EQUALS invalid number	0	0	0	0	0
NOT_EQUALS 0	0	1	1	1	1
NOT_EQUALS 1	1	1	1	1	1
NOT_EQUALS -1	1	1	0	1	1
NOT_EQUALS 10	1	0	1	1	1
NOT_EQUALS empty	1	1	1	0	1
NOT_EQUALS invalid number	1	1	1	1	1
LESS_THAN 5	1	0	1	0	0
LESS_THAN empty	0	0	0	0	0
LESS_THAN invalid number	0	1	0	0	0
LESS_THAN_OR_EQUAL 0	1	0	1	0	0
LESS_THAN_OR_EQUAL empty	0	0	0	0	0
LESS_THAN_OR_EQUAL invalid number	0	0	0	0	0
GREATER_THAN 10	0	0	0	0	0
GREATER_THAN 0	0	1	0	0	0
GREATER_THAN -1	1	1	0	0	0
GREATER_THAN empty	0	0	0	0	0
GREATER_THAN invalid number	0	0	0	0	0
GREATER_THAN_OR_EQUAL 10	0	1	0	0	0
GREATER_THAN_OR_EQUAL empty	0	0	0	0	0
GREATER_THAN_OR_EQUAL invalid number	0	0	0	0	0

Suffixes conditions

use is an optional attribute that can be added to a condition. It allows to specify the data to use in the condition.

TIP

Active and archived Suffixes can be used in the condition. In the interface a warning is displayed next to archived Suffixes.

use value	Description
VALUE	Default, The item cell value. If the use attribute is not set, the default value is used
SUFFIX_KEY	The key of the suffix associated with the item cell. In this case, the suffix being a text, the available conditions are not based on the field type. The available conditions are the same as for the text field type.
SUFFIX	Synonym to SUFFIX_KEY.

Example: The item cell (key PRICE) value must not be empty, and the item cell (key PRICE) suffix key should be equal to euro

<Conditions>
    <Condition-Group>
        <Condition source="PRICE" operator="NOT_EMPTY"/>
        <Condition source="PRICE" use="SUFFIX_KEY" operator="EQUALS">
            <Value>euro</Value>
        </Condition>
    </Condition-Group>
</Conditions>

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
EQUALS	The value must reference a valid suffix key.	Mandatory, a single value allowed
NOT_EQUALS	Does not equal the mentioned suffix. The value must reference a valid suffix key.	Mandatory, a single value allowed
CONTAINS	Contains (not case and accent sensitive)	Mandatory, a single value allowed
STARTS_WITH	Like by (case and accent sensitive)	Mandatory, a single value allowed
ENDS_WITH	Ends with (case and accent sensitive)	Mandatory, a single value allowed

TIP

In the case of a suffix list, the expected values for the Value tag are the keys of the target suffixes.

#	Suffix : ['a']	Suffix : ['b']	Suffix : [] / empty / null
EMPTY	0	0	1
NOT_EMPTY	1	1	0
EQUALS a	1	0	0
EQUALS b	0	1	0
EQUALS c	0	0	0
EQUALS empty	0	0	1
NOT_EQUALS a	0	1	1
NOT_EQUALS b	1	0	1
NOT_EQUALS c	1	1	1
NOT_EQUALS empty	1	1	0
CONTAINS a	1	0	0
CONTAINS b	0	1	0
CONTAINS ab	0	0	0
CONTAINS c	0	0	0
CONTAINS empty	0	0	0
STARTS_WITH a	1	0	1
STARTS_WITH b	0	1	0
STARTS_WITH ab	0	0	1
STARTS_WITH c	0	0	0
STARTS_WITH empty	0	0	0
ENDS_WITH a	1	0	0
ENDS_WITH b	0	1	0
ENDS_WITH ab	0	0	0
ENDS_WITH c	0	0	0
ENDS_WITH empty	0	0	0

MULTIPLE-SELECT, MULTIPLE_SELECT_QUANTIFIED, MULTIPLE_SELECT_QUANTIFIED_WITH_COMMENTS or

MULTIPLE_SELECT_WITH_COMMENTS conditions

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
EQUALS	The value must reference a valid option key.	Mandatory, a single value allowed (or several in the case of multiple lists)
NOT_EQUALS	Does not equal the mentioned option. The value must reference a valid option key.	Mandatory, a single value allowed
IN	Is equal to one of the mentioned values (a minimum value)	Mandatory, multiple value allowed
NOT_IN	Does not equal any of the mentioned values (a minimum value)	Mandatory, multiple value allowed

TIP

In the case of an option list, the expected values for the Value tag are the keys of the target options.

Example:

<Conditions>
    <Condition-Group>
        <Condition target="color" operator="NOT_IN">
            <Value>red</Value>
            <Value>blue</Value>
        </Condition>
    </Condition-Group>
</Conditions>

Other examples may be found here

#	Field : ['a']	Field : ['b']	Field : ['a', 'b']	Field : [] / empty / null
EMPTY	0	0	0	1
NOT_EMPTY	1	1	1	0
EQUALS ['a']	1	0	0	0
EQUALS 'a'	1	0	0	0
EQUALS ['b']	0	1	0	0
EQUALS 'b'	0	1	0	0
EQUALS ['c']	0	0	0	0
EQUALS ['a', 'b']	0	0	1	0
EQUALS ['b', 'a']	0	0	1	0
EQUALS ['a', 'b', 'c']	0	0	0	0
EQUALS empty	0	0	0	1
NOT_EQUALS ['a']	0	1	1	1
NOT_EQUALS 'a'	0	1	1	1
NOT_EQUALS ['b']	1	0	1	1
NOT_EQUALS 'b'	1	0	1	1
NOT_EQUALS ['c']	1	1	1	1
NOT_EQUALS ['a', 'b']	1	1	0	1
NOT_EQUALS ['b', 'a']	1	1	0	1
NOT_EQUALS ['a', 'b', 'c']	1	1	1	1
NOT_EQUALS empty	1	1	1	0
IN ['a']	1	0	1	0
IN ['b']	0	1	1	0
IN ['a', 'b']	1	1	1	0
IN ['b', 'a']	1	1	1	0
IN ['a', 'b', 'c']	1	1	1	0
IN ['c']	0	0	0	0
IN ['a', 'c']	1	0	1	0
IN empty	0	0	0	0
NOT_IN ['a']	0	1	1	1
NOT_IN ['b']	1	0	1	1
NOT_IN ['a', 'b']	0	0	0	1
NOT_IN ['b', 'a']	0	0	0	1
NOT_IN ['a', 'b', 'c']	0	0	0	1
NOT_IN ['c']	1	1	1	1
NOT_IN ['a', 'c']	0	1	1	1
NOT_IN empty	1	1	1	0

SINGLE-SELECT conditions

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
EQUALS	The value must reference a valid option key.	Mandatory, a single value allowed (or several in the case of multiple lists)
NOT_EQUALS	Does not equal the mentioned option. The value must reference a valid option key.	Mandatory, a single value allowed
IN	Is equal to one of the mentioned values (a minimum value)	Mandatory, multiple value allowed
NOT_IN	Does not equal any of the mentioned values (a minimum value)	Mandatory, multiple value allowed

TIP

In the case of an option list, the expected values for the Value tag are the keys of the target options.

Example:

<Conditions>
    <Condition-Group>
        <Condition target="color" operator="NOT_IN">
            <Value>red</Value>
            <Value>blue</Value>
        </Condition>
    </Condition-Group>
</Conditions>

Other examples may be found here

#	Field : ['a']	Field : ['b']	Field : [] / empty / null
EMPTY	0	0	1
NOT_EMPTY	1	1	0
EQUALS 'a'	1	0	0
EQUALS 'b'	0	1	0
EQUALS 'c'	0	0	0
EQUALS ['a']	0	0	0
EQUALS ['a', 'b']	0	0	0
EQUALS ['b', 'a']	0	0	0
EQUALS ['a', 'b', 'c']	0	0	0
EQUALS empty	0	0	1
NOT_EQUALS 'a'	0	1	1
NOT_EQUALS 'b'	1	0	1
NOT_EQUALS 'c'	1	1	1
NOT_EQUALS empty	1	1	0
IN ['a']	1	0	0
IN ['b']	0	1	0
IN ['a', 'b']	1	1	0
IN ['b', 'a']	1	1	0
IN ['a', 'b', 'c']	1	1	0
IN ['c']	0	0	0
IN ['a', 'c']	1	0	0
IN empty	0	0	0
NOT_IN ['a']	0	1	1
NOT_IN ['b']	1	0	1
NOT_IN ['a', 'b']	0	0	1
NOT_IN ['b', 'a']	0	0	1
NOT_IN ['a', 'b', 'c']	0	0	1
NOT_IN ['c']	1	1	1
NOT_IN ['a', 'c']	0	1	1
NOT_IN empty	1	1	0

Quantity conditions

use is an optional attribute that can be added to a condition. It allows to specify the data to use in the condition.

'use' value	Description
VALUE	Default, The item option key. If the use attribute is not set, the value option key is used
QUANTITY	The item option quantity. In this case, the quantity being a number, the available conditions are the same as for the number field type.

Example: The item option (key DEA) must have a quantity of at least 1

<Field key="DEA">
    <Rule-Condition key="QUANTITY_LESS_THAN_1">
        <Conditions>
            <Condition-Group>
                <Condition source="DEA" operator="LESS_THAN" use="QUANTITY">
                    <Value>1</Value>
                </Condition>
            </Condition-Group>
        </Conditions>
        <Title>A quantity of at least 1 must be set per DEA</Title>
    </Rule-Condition>
</Field>

Operator	Description	Parameter
EMPTY	Is empty	N/A
NOT_EMPTY	Is not empty	N/A
LESS_THAN	Strictly inferior	Mandatory, a single value allowed
LESS_THAN_OR_EQUAL	Less than or equal	Mandatory, a single value allowed
GREATER_THAN	Strictly superior	Mandatory, a single value allowed
GREATER_THAN_OR_EQUAL	Greater than or equal	Mandatory, a single value allowed
EQUALS	Strictly equal	Mandatory, a single value allowed

#	Number = 0	Number = 10	Number = -1	Number is empty (null)	invalid number
EMPTY	0	0	0	1	0
NOT_EMPTY	1	1	1	0	1
EQUALS 0	1	0	0	0	0
EQUALS 1	0	0	0	0	0
EQUALS -1	0	0	1	0	0
EQUALS 10	0	1	0	0	0
EQUALS empty	0	0	0	1	0
EQUALS invalid number	0	0	0	0	0
NOT_EQUALS 0	0	1	1	1	1
NOT_EQUALS 1	1	1	1	1	1
NOT_EQUALS -1	1	1	0	1	1
NOT_EQUALS 10	1	0	1	1	1
NOT_EQUALS empty	1	1	1	0	1
NOT_EQUALS invalid number	1	1	1	1	1
LESS_THAN 5	1	0	1	0	0
LESS_THAN empty	0	0	0	0	0
LESS_THAN invalid number	0	1	0	0	0
LESS_THAN_OR_EQUAL 0	1	0	1	0	0
LESS_THAN_OR_EQUAL empty	0	0	0	0	0
LESS_THAN_OR_EQUAL invalid number	0	0	0	0	0
GREATER_THAN 10	0	0	0	0	0
GREATER_THAN 0	0	1	0	0	0
GREATER_THAN -1	1	1	0	0	0
GREATER_THAN empty	0	0	0	0	0
GREATER_THAN invalid number	0	0	0	0	0
GREATER_THAN_OR_EQUAL 10	0	1	0	0	0
GREATER_THAN_OR_EQUAL empty	0	0	0	0	0
GREATER_THAN_OR_EQUAL invalid number	0	0	0	0	0

IMAGE, ATTACHMENT conditions

Operator	Description	Parameter
EMPTY	Is empty	NA
NOT_EMPTY	Is not empty	NA

DATE, DATE-TIME conditions

Operator	Description	Parameter
EMPTY	Is empty	NA
NOT_EMPTY	Is not empty	NA
LESS_THAN	Strictly inferior	Mandatory, a single value allowed
LESS_THAN_OR_EQUAL	Less than or equal	Mandatory, a single value allowed
GREATER_THAN	Strictly superior	Mandatory, a single value allowed
GREATER_THAN_OR_EQUAL	Greater than or equal	Mandatory, a single value allowed
EQUALS	Strictly equal	Mandatory, a single value allowed

WARNING

The value provided in the condition must be a valid date, see https://tc39.es/ecma262/#sec-date-time-string-format ( also https://en.wikipedia.org/wiki/ISO_8601#Dates. If the value provided is not a valid number, the condition will always be falsy and a log will be added to the execution report (ERROR_WHILE_EVALUATING_A_CONDITION).

Performing a condition against another value

A condition can be made against a static value or against the value of another field:

• In the first case, if the condition is used using the Data Factory task table-import-schema, the value is mentionned in the Value tag of the condition.
• In the latter case, if the condition is used using the Data Factory task table-import-schema, the target field must be referenced in a Field tag.
• Examples for those rules may be found here

Performing a condition against another field value is a feature behind a feature flag

This feature is in beta phase and placed behind a feature flag.